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.
The formo charts command group lets you manage charts within dashboard boards. Charts are always scoped to a specific board.
List all charts for a board.
Requires boards:read scope on your API key.
Options
| Option | Type | Required | Description |
|---|
--board-id | string | ✅ | Board ID to list charts from |
formo charts list --board-id board_abc123
Get a single chart by ID.
Requires boards:read scope on your API key.
Arguments
| Argument | Type | Required | Description |
|---|
chartId | string | ✅ | Chart ID |
Options
| Option | Type | Required | Description |
|---|
--board-id | string | ✅ | Board ID the chart belongs to |
formo charts get chart_abc123 --board-id board_abc123
Create a new chart in a board.
Requires boards:write scope on your API key.
Options
| Option | Type | Required | Description |
|---|
--board-id | string | ✅ | Board ID to add the chart to |
--body | string | ✅ | JSON string with the chart configuration |
Examples
# Create a line chart
formo charts create \
--board-id board_abc123 \
--body '{"name":"Daily active users","chartType":"line"}'
# Create a bar chart with a SQL query
formo charts create \
--board-id board_abc123 \
--body '{"name":"Top chains","chartType":"bar","query":"SELECT chain, count(*) as cnt FROM events GROUP BY chain ORDER BY cnt DESC LIMIT 10"}'
Update an existing chart.
Requires boards:write scope on your API key.
Arguments
| Argument | Type | Required | Description |
|---|
chartId | string | ✅ | Chart ID to update |
Options
| Option | Type | Required | Description |
|---|
--board-id | string | ✅ | Board ID the chart belongs to |
--body | string | ✅ | JSON string with updated chart configuration |
Examples
# Update a chart name
formo charts update chart_abc123 \
--board-id board_abc123 \
--body '{"name":"Updated chart name"}'
# Update chart type and query
formo charts update chart_abc123 \
--board-id board_abc123 \
--body '{"name":"Revenue","chartType":"area","query":"SELECT DATE(timestamp) as day, SUM(revenue) as rev FROM events GROUP BY day"}'
Delete a chart.
Requires boards:write scope on your API key.
Arguments
| Argument | Type | Required | Description |
|---|
chartId | string | ✅ | Chart ID to delete |
Options
| Option | Type | Required | Description |
|---|
--board-id | string | ✅ | Board ID the chart belongs to |
formo charts delete chart_abc123 --board-id board_abc123
Deleting a chart is permanent.
