> ## 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 lets you manage dashboard boards for your project. Boards are containers for charts and can be used to organize your analytics dashboards.

## `formo boards list`

List all boards for the project.

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

```bash theme={null}
formo boards list
```

***

## `formo boards get`

Get a single board by ID.

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

### Arguments

| Argument  | Type     | Required | Description |
| --------- | -------- | -------- | ----------- |
| `boardId` | `string` | ✅        | Board ID    |

```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       |
| --------------- | -------- | -------- | ----------------- |
| `--name`        | `string` | ✅        | Board name        |
| `--description` | `string` | ❌        | Board description |

### Examples

```bash theme={null}
# Create a board
formo boards create --name "KPI Dashboard"

# Create a board with a description
formo boards create --name "Revenue Metrics" --description "Weekly revenue tracking"
```

***

## `formo boards update`

Update an existing board.

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

### Arguments

| Argument  | Type     | Required | Description        |
| --------- | -------- | -------- | ------------------ |
| `boardId` | `string` | ✅        | Board ID to update |

### Options

| Option          | Type     | Required | Description           |
| --------------- | -------- | -------- | --------------------- |
| `--name`        | `string` | ❌        | New board name        |
| `--description` | `string` | ❌        | New board description |

### Examples

```bash theme={null}
# Rename a board
formo boards update board_abc123 --name "Renamed Board"

# Update description
formo boards update board_abc123 --description "Updated weekly metrics"
```

***

## `formo boards delete`

Delete a board.

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

### Arguments

| Argument  | Type     | Required | Description        |
| --------- | -------- | -------- | ------------------ |
| `boardId` | `string` | ✅        | Board ID to delete |

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

<Warning>
  Deleting a board is permanent and will also remove all charts associated with it.
</Warning>