Skip to main content

# kater chart list

Lists the saved charts that read one query, in the order they show under it.

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

Each chart comes with its title, its spec, its SQL and its revision. It changes nothing.

## Examples

```bash
# List the saved charts that read spend_by_platform
kater chart list --request-file spend_by_platform.json
# Keep the list in a file, to read the revisions with jq
kater chart list --request-file spend_by_platform.json --json > spend_by_platform_charts.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 query, as JSON, such as `spend_by_platform.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 |
| --- | --- |
| `source` | The query: its `name`, and the full `path` of its workspace under `namespace`. |
| `inputs` | Optional. The query's parameter values in `parameters`, and the optional filters to turn on in `filters`. |

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

For `spend_by_platform`, the list has two charts: `spend_by_platform`, a bar chart, and `spend_mix`, a pie chart. Each chart in `charts` has the fields that [`kater chart read`](https://kater.ai/docs/cli-reference/chart/read/) shows.

## See also

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

On this page

Examples
Arguments
Options
The request
See also

Kater CLI Present and share chart

kater chart list

Lists the saved charts that read one query, in the order they show under it.

Each chart comes with its title, its spec, its SQL and its revision. It changes nothing.

Examples

# List the saved charts that read spend_by_platform
kater chart list --request-file spend_by_platform.json
# Keep the list in a file, to read the revisions with jq
kater chart list --request-file spend_by_platform.json --json > spend_by_platform_charts.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 query, as JSON, such as `spend_by_platform.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
`source`	The query: its `name`, and the full `path` of its workspace under `namespace`.
`inputs`	Optional. The query’s parameter values in `parameters`, and the optional filters to turn on in `filters`.

{"source": {"name": "spend_by_platform", "namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}}}

For spend_by_platform, the list has two charts: spend_by_platform, a bar chart, and spend_mix, a pie chart. Each chart in charts has the fields that kater chart read shows.

See also