Skip to main content
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

OptionTypeRequiredDescription
--pagenumberPage number, 1-indexed
--sizenumberPage 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

OptionTypeRequiredDescription
--titlestringBoard title
--namestringDeprecated alias for --title
--descriptionstringBoard description
--is-publicbooleanWhether 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

OptionTypeRequiredDescription
--titlestringNew board title
--namestringDeprecated alias for --title
--descriptionstringNew board description
--is-publicbooleanWhether 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.