Boards

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.

Requires boards:read scope on your API key.

Options

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

formo boards list --size 25

`formo boards get <boardId>`

Get a single board by ID.

Requires boards:read scope on your API key.

formo boards get board_abc123

`formo boards create`

Create a new dashboard board.

Requires boards:write scope on your API key.

Options

Option	Type	Required	Description
`--title`	`string`	✅	Board title
`--name`	`string`	❌	Deprecated alias for `--title`
`--description`	`string`	❌	Board description
`--is-public`	`boolean`	❌	Whether the board is publicly viewable

Examples

formo boards create --title "KPI Dashboard"
formo boards create --title "Revenue Metrics" --description "Weekly revenue tracking" --is-public false

`formo boards update <boardId>`

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

Requires boards:write scope on your API key.

Options

Option	Type	Required	Description
`--title`	`string`	❌	New board title
`--name`	`string`	❌	Deprecated alias for `--title`
`--description`	`string`	❌	New board description
`--is-public`	`boolean`	❌	Whether the board is publicly viewable

formo boards update board_abc123 --title "Renamed Board"
formo boards update board_abc123 --description "Updated weekly metrics" --is-public true

`formo boards delete <boardId>`

Delete a board.

Requires boards:write scope on your API key.

formo boards delete board_abc123

Deleting a board is permanent and also removes its charts.

CLI

Commands

`formo boards list`

Options

`formo boards get <boardId>`

`formo boards create`

Options

Examples

`formo boards update <boardId>`

Options

`formo boards delete <boardId>`

​formo boards list

​Options

​formo boards get <boardId>

​formo boards create

​Options

​Examples

​formo boards update <boardId>

​Options

​formo boards delete <boardId>

`formo boards list`

Options

`formo boards get <boardId>`

`formo boards create`

Options

Examples

`formo boards update <boardId>`

Options

`formo boards delete <boardId>`