Skip to main content

# kater dashboard open

Reads a workspace's dashboard.

{/* 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. */}

When `dashboard.yaml` is missing, the answer holds Kater's own starting dashboard, and with `scaffold` set to true and permission to change the workspace, Kater saves it first. The answer holds the file, its revision, its tiles and the workspace's filters.

## Examples

```bash
# Open the ad_reporting dashboard
kater dashboard open --request-file ad_reporting.json
# Save Kater's starting dashboard when the workspace has none
jq '.scaffold = true' ad_reporting.json > ad_reporting_start.json
kater dashboard open --request-file ad_reporting_start.json
# Make a faster request, without the workspace's filters, and send it
jq '.include_inputs = false' ad_reporting.json > ad_reporting_quick.json
kater dashboard open --request-file ad_reporting_quick.json
```

## Arguments

<div class="cli-options">

| Argument | Description |
| --- | --- |
| `<path>` | Optional. In place of `--request-file`: the workspace, the query file or the chart file the request names. |

</div>

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--request-file <file>` | The workspace, as JSON, such as `ad_reporting.json`. Give `-` to read it from standard input. See [The request](#the-request). |

</div>

It also takes the [global options](https://kater.ai/docs/cli-reference/global-options/) `--json`, `--kater-root`, `--scope` and `--help`.

## The request

| Field | What it holds |
| --- | --- |
| `namespace` | The workspace, by its full `path`. |
| `scaffold` | Optional, false when you leave it out. True saves Kater's starting dashboard when the file is missing and you can change the workspace. False only reads. |
| `include_inputs` | Optional, true when you leave it out. False answers faster, because Kater does not compile `workspace.sql`. The answer then has no `inputs`. |

## What it shows

| Field | What it holds |
| --- | --- |
| `file` | The whole `dashboard.yaml` as data. [`kater dashboard save`](https://kater.ai/docs/cli-reference/dashboard/save/) takes it back. |
| `revision` | The file's revision. It is missing when there is no file. |
| `scaffolded` | Whether the file was missing, so that this dashboard is Kater's starting one. |
| `saved` | Whether `dashboard.yaml` is on disk after the call. |
| `can_write` | Whether you can change the dashboard. |
| `problems` | What is wrong in the file. |
| `inputs` | The filters and parameters that `workspace.sql` declares, in its order. |
| `charts` | Every saved chart in the workspace, whether it is a tile or not. |
| `queries` | Every query in the workspace, whether it has a saved chart or not. |

## See also

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

On this page

Examples
Arguments
Options
The request
What it shows
See also

Kater CLI Present and share dashboard

kater dashboard open

Reads a workspace's dashboard.

When dashboard.yaml is missing, the answer holds Kater’s own starting dashboard, and with scaffold set to true and permission to change the workspace, Kater saves it first. The answer holds the file, its revision, its tiles and the workspace’s filters.

Examples

# Open the ad_reporting dashboard
kater dashboard open --request-file ad_reporting.json
# Save Kater's starting dashboard when the workspace has none
jq '.scaffold = true' ad_reporting.json > ad_reporting_start.json
kater dashboard open --request-file ad_reporting_start.json
# Make a faster request, without the workspace's filters, and send it
jq '.include_inputs = false' ad_reporting.json > ad_reporting_quick.json
kater dashboard open --request-file ad_reporting_quick.json

Arguments

Argument	Description
`<path>`	Optional. In place of `--request-file`: the workspace, the query file or the chart file the request names.

Options

Option	Description
`--request-file <file>`	The workspace, as JSON, such as `ad_reporting.json`. Give `-` to read it from standard input. See The request.

It also takes the global options --json, --kater-root, --scope and --help.

The request

Field	What it holds
`namespace`	The workspace, by its full `path`.
`scaffold`	Optional, false when you leave it out. True saves Kater’s starting dashboard when the file is missing and you can change the workspace. False only reads.
`include_inputs`	Optional, true when you leave it out. False answers faster, because Kater does not compile `workspace.sql`. The answer then has no `inputs`.

What it shows

Field	What it holds
`file`	The whole `dashboard.yaml` as data. `kater dashboard save` takes it back.
`revision`	The file’s revision. It is missing when there is no file.
`scaffolded`	Whether the file was missing, so that this dashboard is Kater’s starting one.
`saved`	Whether `dashboard.yaml` is on disk after the call.
`can_write`	Whether you can change the dashboard.
`problems`	What is wrong in the file.
`inputs`	The filters and parameters that `workspace.sql` declares, in its order.
`charts`	Every saved chart in the workspace, whether it is a tile or not.
`queries`	Every query in the workspace, whether it has a saved chart or not.

See also