> ## Documentation Index
> Fetch the complete documentation index at: https://docs.formo.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Boards

> Manage analytics dashboard boards from the terminal with the Formo CLI. Create, list, update, and delete boards that organize your charts and reports.

The `formo boards` command group manages dashboard boards for the active project. Boards are containers for charts.

## `formo boards list`

List all boards for the project.

<Note>
  Requires `boards:read` scope on your API key.
</Note>

### Options

| Option | Type | Required | Description |
| - | - | - | - |
| `--page` | `number` | ❌ | Page number, 1-indexed |
| `--size` | `number` | ❌ | Page size |

```bash theme={null}
formo boards list --size 25
```

***

## `formo boards get <boardId>`

Get a single board by ID.

<Note>
  Requires `boards:read` scope on your API key.
</Note>

```bash theme={null}
formo boards get board_abc123
```

***

## `formo boards create`

Create a new dashboard board.

<Note>
  Requires `boards:write` scope on your API key.
</Note>

### Options

| Option | Type | Required | Description |
| - | - | - | - |
| `--title` | `string` | ✅ | Board title |
| `--name` | `string` | ❌ | Deprecated alias for `--title` |
| `--description` | `string` | ❌ | Board description |
| `--is-public` | `boolean` | ❌ | Make the board publicly viewable. Omit to keep it private (the default). |

<Note>
  Boolean flags do not read a following value. Write `--is-public` to enable, and
  `--is-public=false` or `--no-is-public` to disable. `--is-public false` sets it to **true** and
  leaves `false` as a stray argument.
</Note>

### Examples

```bash theme={null}
formo boards create --title "KPI Dashboard"
formo boards create --title "Revenue Metrics" --description "Weekly revenue tracking" --is-public
```

***

## `formo boards update <boardId>`

Update an existing board. Provide at least one updatable option.

<Note>
  Requires `boards:write` scope on your API key.
</Note>

### Options

| Option | Type | Required | Description |
| - | - | - | - |
| `--title` | `string` | ❌ | New board title |
| `--name` | `string` | ❌ | Deprecated alias for `--title` |
| `--description` | `string` | ❌ | New board description |
| `--is-public` | `boolean` | ❌ | Make the board publicly viewable. Omit to keep the stored setting. |

<Note>
  `--is-public` is a boolean flag: pass `--is-public=false` or `--no-is-public` to disable it. See
  [boolean flags](#formo-boards-create) above.
</Note>

```bash theme={null}
formo boards update board_abc123 --title "Renamed Board"
formo boards update board_abc123 --description "Updated weekly metrics" --is-public
```

***

## `formo boards delete <boardId>`

Delete a board.

<Note>
  Requires `boards:write` scope on your API key.
</Note>

```bash theme={null}
formo boards delete board_abc123
```

<Warning>
  Deleting a board is permanent and also removes its charts.
</Warning>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.