Skip to main content

# kater chart prompt

Writes a prompt that asks an agent to finish a chart that cannot draw yet.

{/* 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 it the chart's spec and its plan, and paste the text it gives into your agent. It writes nothing, and the prompt holds no rows.

## Examples

```bash
# Keep the spend_mix chart in a file
kater chart read --request-file spend_mix.json --json > spend_mix_read.json
# Make a prompt request from its spec and its plan
jq '{spec: .definition.spec, plan: .definition.plan}' spend_mix_read.json > spend_mix_prompt.json
# Write the prompt
kater chart prompt --request-file spend_mix_prompt.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 chart, as JSON: its spec and its plan. 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 |
| --- | --- |
| `spec` | The chart the prompt asks for. It can still lack fields that its kind needs. |
| `plan` | The query columns that each of the chart's outputs shows, as the `plan` of `kater chart read` holds them. |
| `inputs` | Optional. The query's parameter values and filters, for the prompt to keep. Leave it out when you do not know them. |
| `requirement` | Optional. Why the chart cannot draw yet, as the chart builder showed it. |

The answer's `prompt` holds the text. It names no agent.

## 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 prompt

Writes a prompt that asks an agent to finish a chart that cannot draw yet.

Give it the chart’s spec and its plan, and paste the text it gives into your agent. It writes nothing, and the prompt holds no rows.

Examples

# Keep the spend_mix chart in a file
kater chart read --request-file spend_mix.json --json > spend_mix_read.json
# Make a prompt request from its spec and its plan
jq '{spec: .definition.spec, plan: .definition.plan}' spend_mix_read.json > spend_mix_prompt.json
# Write the prompt
kater chart prompt --request-file spend_mix_prompt.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 chart, as JSON: its spec and its plan. 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
`spec`	The chart the prompt asks for. It can still lack fields that its kind needs.
`plan`	The query columns that each of the chart’s outputs shows, as the `plan` of `kater chart read` holds them.
`inputs`	Optional. The query’s parameter values and filters, for the prompt to keep. Leave it out when you do not know them.
`requirement`	Optional. Why the chart cannot draw yet, as the chart builder showed it.

The answer’s prompt holds the text. It names no agent.

See also