# plotwork board list

> Page: https://docs.plotwork.dev/cli/commands/board-list. Index of every page: https://docs.plotwork.dev/llms.txt

List the live whiteboards the key may open, newest change first. It is a command of the Plotwork command line, the npm package `@buun_group/plotwork`.

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | List the live whiteboards the key may open, newest change first. |
| How do I run it? | `npx -y @buun_group/plotwork@0.2.0 board list`, or `plotwork board list` once the package is installed. |
| What does it write? | Nothing on this machine. |
| Does it use the network? | Yes: calls to the Plotwork API with the key in `PLOTWORK_API_KEY`, which is never printed. |
| Does it read the repository settings? | No. |
| How do I read this in a terminal? | `plotwork board list --help` |

## Synopsis

```sh
plotwork board list [--org <slug>] [--query <text>] [--limit <n>] [--json]
```

## What it does

Lists the boards of the organisation of the key in `PLOTWORK_API_KEY` that the key may open: an organisation key with the `boards` scope sees the boards open to the whole organisation. A board shared with named people only is closed to keys.

A board is named by its id, its address in the portal (an address with `#tab-<id>` also names the tab), or its name; a tab by its id or its name. A name costs one more call to look it up.

## Options

| Option | Default | What it does |
|---|---|---|
| `--org <slug>` | Off | Fail unless the key is of this organisation. A key reaches only its own organisation's boards. |
| `--query <text>` | Off | Only the boards whose name holds this text. |
| `--limit <n>` | 100 | How many boards to list, 1 to 100. |
| `--json` | Off | Print one JSON document: the API's answer when it worked, or `{ "error": true, "errorCode", "message", "hint", "status" }` when it did not. |

## Examples

List the boards the key may open.

```sh
plotwork board list
```

The same as JSON, failing unless the key is of Acme.

```sh
plotwork board list --org acme --json
```

## Exit codes

| Code | When |
|---|---|
| `0` | The boards were listed. |
| `1` | The API refused the call (its code, words and a hint are printed), or could not be reached. |
| `2` | A mistake in the command line: an unknown option, a missing operand, a file or glob that matches nothing, or a settings file that cannot be read. Also when `PLOTWORK_API_KEY` is missing or refused, or `--org` names another organisation than the key's. |

## See also

| Doc | Why |
|---|---|
| [Command reference](https://docs.plotwork.dev/cli/commands.md) | Every command of the command line |
| [Live whiteboards](https://docs.plotwork.dev/live-whiteboards.md) | Boards, tabs, revisions and who may change them |
| [From the command line](https://docs.plotwork.dev/live-whiteboards.md#9-from-the-command-line) | Signing in, pull and push, conflicts, and watch |
| [Claude Code plugin](https://docs.plotwork.dev/agents/claude-code-plugin.md) | The board and board-sync skills |
| [Exit codes and output formats](https://docs.plotwork.dev/cli/exit-codes-and-output.md) | What every code and format means |