Skip to main content

# kater dashboard save

Checks and saves a whole 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. */}

Give the file as JSON data, with the revision you opened. Kater then refuses the save when someone changed the dashboard after you opened it. Errors stop the save, and warnings do not.

## Examples

```bash
# Keep the ad_reporting dashboard in a file
kater dashboard open --request-file ad_reporting.json --json > ad_reporting_open.json
# Make a request that only checks the dashboard as it is
jq '{namespace, file, expected_revision: .revision, dry_run: true}' ad_reporting_open.json > ad_reporting_check.json
# Check it, and save nothing
kater dashboard save --request-file ad_reporting_check.json
# Make a request that renames the Overview section to Summary, and save it
jq '{namespace, file: (.file | .sections.overview.label = "Summary"), expected_revision: .revision}' ad_reporting_open.json > ad_reporting_save.json
kater dashboard save --request-file ad_reporting_save.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, the whole file and its revision, as 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`. |
| `file` | The whole `dashboard.yaml` as data, as the `file` of [`kater dashboard open`](https://kater.ai/docs/cli-reference/dashboard/open/) holds it. |
| `expected_revision` | Optional. The `revision` from `kater dashboard open`. |
| `dry_run` | Optional. True checks the file and saves nothing. |
| `include_inputs` | Optional, true when you leave it out. False answers faster, without the workspace's filters. |

## When Kater refuses

- **The file has errors.** The answer names them, and nothing is saved.
- **The dashboard changed** after you opened it. Open it again, and try again.
- **You cannot change the workspace.**
- **An editor has unsaved changes** in `dashboard.yaml`.

The answer's `written` says whether Kater saved the file.

## 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
When Kater refuses
See also

Kater CLI Present and share dashboard

kater dashboard save

Checks and saves a whole dashboard.yaml.

Give the file as JSON data, with the revision you opened. Kater then refuses the save when someone changed the dashboard after you opened it. Errors stop the save, and warnings do not.

Examples

# Keep the ad_reporting dashboard in a file
kater dashboard open --request-file ad_reporting.json --json > ad_reporting_open.json
# Make a request that only checks the dashboard as it is
jq '{namespace, file, expected_revision: .revision, dry_run: true}' ad_reporting_open.json > ad_reporting_check.json
# Check it, and save nothing
kater dashboard save --request-file ad_reporting_check.json
# Make a request that renames the Overview section to Summary, and save it
jq '{namespace, file: (.file | .sections.overview.label = "Summary"), expected_revision: .revision}' ad_reporting_open.json > ad_reporting_save.json
kater dashboard save --request-file ad_reporting_save.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, the whole file and its revision, as 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`.
`file`	The whole `dashboard.yaml` as data, as the `file` of `kater dashboard open` holds it.
`expected_revision`	Optional. The `revision` from `kater dashboard open`.
`dry_run`	Optional. True checks the file and saves nothing.
`include_inputs`	Optional, true when you leave it out. False answers faster, without the workspace’s filters.

When Kater refuses

The file has errors. The answer names them, and nothing is saved.
The dashboard changed after you opened it. Open it again, and try again.
You cannot change the workspace.
An editor has unsaved changes in dashboard.yaml.

The answer’s written says whether Kater saved the file.

See also