Skip to main content
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.
Requires boards:read scope on your API key.
formo boards list

​
formo boards get

Get a single board by ID.
Requires boards:read scope on your API key.

​
Arguments

ArgumentTypeRequiredDescription
boardIdstring✅Board ID
formo boards get board_abc123

​
formo boards create

Create a new dashboard board.
Requires boards:write scope on your API key.

​
Options

OptionTypeRequiredDescription
--namestring✅Board name
--descriptionstring❌Board description

​
Examples

# 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.
Requires boards:write scope on your API key.

​
Arguments

ArgumentTypeRequiredDescription
boardIdstring✅Board ID to update

​
Options

OptionTypeRequiredDescription
--namestring❌New board name
--descriptionstring❌New board description

​
Examples

# 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.
Requires boards:write scope on your API key.

​
Arguments

ArgumentTypeRequiredDescription
boardIdstring✅Board ID to delete
formo boards delete board_abc123
Deleting a board is permanent and will also remove all charts associated with it.