Skip to main content

# kater dashboard

Opens, changes and lays out the dashboard of a workspace, which is its dashboard.yaml.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

A dashboard shows saved charts as tiles, in sections and tabs. The `inputs` commands keep your own filter values for a dashboard, and change nothing for anyone else. See [Dashboards](https://kater.ai/docs/analyze/dashboards/).

## Commands

| Command | What it does |
| --- | --- |
| [`kater dashboard look`](https://kater.ai/docs/cli-reference/dashboard/look/) | Look at a dashboard as you see it, and print what is wrong with it. |
| [`kater dashboard open`](https://kater.ai/docs/cli-reference/dashboard/open/) | Open a workspace's dashboard. With `scaffold: true`, save Kater's scaffold when the workspace has none. |
| [`kater dashboard save`](https://kater.ai/docs/cli-reference/dashboard/save/) | Check and save a whole dashboard.yaml. |
| [`kater dashboard fill`](https://kater.ai/docs/cli-reference/dashboard/fill/) | Put charts on a dashboard and arrange the whole board. |
| [`kater dashboard text`](https://kater.ai/docs/cli-reference/dashboard/text/) | Put text on a dashboard, to tell its story beside its charts. |
| [`kater dashboard tiles`](https://kater.ai/docs/cli-reference/dashboard/tiles/) | Add charts to a dashboard or take them off. |
| [`kater dashboard layout`](https://kater.ai/docs/cli-reference/dashboard/layout/) | Plan where charts sit on a dashboard. |
| [`kater dashboard inputs`](https://kater.ai/docs/cli-reference/dashboard/inputs/) | Keep, show or forget your own dashboard filters. |

## The request file

Each command reads one JSON object from the file that `--request-file` names. Give `-` to read the request from standard input. Name the workspace by its full path from the content root. Many commands take this file as it is:

```json title="ad_reporting.json"
{"namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}}
```

Run the commands from any folder in your local copy of Kater content. Each command sends one operation, and a dot in the operation's name is a space here: `dashboard.tiles.add` is `kater dashboard tiles add`.

## Revisions

A command that changes the dashboard can take its `expected_revision`: the `revision` that `kater dashboard open` gave. When someone changed `dashboard.yaml` after you opened it, Kater refuses the change. Open the dashboard again, and try again.

## Examples

```bash
# Open the ad_reporting dashboard
kater dashboard open --request-file ad_reporting.json
# Put the spend_by_platform chart on the dashboard
kater dashboard tiles add --request-file add_spend_by_platform.json
# Suggest a place and a size for the tiles of two charts
kater dashboard layout suggest --request-file layout_spend.json
# Show the filter values you kept for the dashboard
kater dashboard inputs read --request-file ad_reporting.json
```

## See also

- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Commands
The request file
Revisions
Examples
See also

Kater CLI Present and share dashboard

kater dashboard

Opens, changes and lays out the dashboard of a workspace, which is its dashboard.yaml.

A dashboard shows saved charts as tiles, in sections and tabs. The inputs commands keep your own filter values for a dashboard, and change nothing for anyone else. See Dashboards.

Commands

Command	What it does
`kater dashboard look`	Look at a dashboard as you see it, and print what is wrong with it.
`kater dashboard open`	Open a workspace’s dashboard. With `scaffold: true`, save Kater’s scaffold when the workspace has none.
`kater dashboard save`	Check and save a whole dashboard.yaml.
`kater dashboard fill`	Put charts on a dashboard and arrange the whole board.
`kater dashboard text`	Put text on a dashboard, to tell its story beside its charts.
`kater dashboard tiles`	Add charts to a dashboard or take them off.
`kater dashboard layout`	Plan where charts sit on a dashboard.
`kater dashboard inputs`	Keep, show or forget your own dashboard filters.

The request file

Each command reads one JSON object from the file that --request-file names. Give - to read the request from standard input. Name the workspace by its full path from the content root. Many commands take this file as it is:

{"namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}}

Run the commands from any folder in your local copy of Kater content. Each command sends one operation, and a dot in the operation’s name is a space here: dashboard.tiles.add is kater dashboard tiles add.

Revisions

A command that changes the dashboard can take its expected_revision: the revision that kater dashboard open gave. When someone changed dashboard.yaml after you opened it, Kater refuses the change. Open the dashboard again, and try again.

Examples

# Open the ad_reporting dashboard
kater dashboard open --request-file ad_reporting.json
# Put the spend_by_platform chart on the dashboard
kater dashboard tiles add --request-file add_spend_by_platform.json
# Suggest a place and a size for the tiles of two charts
kater dashboard layout suggest --request-file layout_spend.json
# Show the filter values you kept for the dashboard
kater dashboard inputs read --request-file ad_reporting.json

See also

All commands