Skip to main content

# kater chart describe

Shows what you can draw from a query: its columns, and what each kind of chart takes.

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

Read it before you write a chart's spec, to know which columns fit each kind. It changes nothing.

## Examples

```bash
# Show the columns of spend_by_platform and what each chart kind takes
kater chart describe --request-file spend_by_platform.json
# Keep the answer in a file, and show only what a pie chart takes
kater chart describe --request-file spend_by_platform.json --json > spend_by_platform_describe.json
jq '.capabilities.pie' spend_by_platform_describe.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"}}}
```

## What it shows

| Field | What it holds |
| --- | --- |
| `authoringContext` | The query's business question, its sources and its comparisons. |
| `columns` | The columns the query returns. |
| `capabilities` | Each chart kind, such as `bar` or `pie`, with its roles, its controls and its presentation settings. |
| `schemaRevision` | The revision of the query's columns. |
| `sourceRevision` | The revision of the query. |

## 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
What it shows
See also

Kater CLI Present and share chart

kater chart describe

Shows what you can draw from a query: its columns, and what each kind of chart takes.

Read it before you write a chart’s spec, to know which columns fit each kind. It changes nothing.

Examples

# Show the columns of spend_by_platform and what each chart kind takes
kater chart describe --request-file spend_by_platform.json
# Keep the answer in a file, and show only what a pie chart takes
kater chart describe --request-file spend_by_platform.json --json > spend_by_platform_describe.json
jq '.capabilities.pie' spend_by_platform_describe.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"}}}

What it shows

Field	What it holds
`authoringContext`	The query’s business question, its sources and its comparisons.
`columns`	The columns the query returns.
`capabilities`	Each chart kind, such as `bar` or `pie`, with its roles, its controls and its presentation settings.
`schemaRevision`	The revision of the query’s columns.
`sourceRevision`	The revision of the query.

See also