Skip to main content

# kater explore card show

Shows a card's query, chart and next questions.

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

Use it to read a card's SQL, fields and conditions before you change or run it. It plans the card again, and runs nothing on the warehouse.

## Examples

```bash
# Show the SQL, chart and next questions of the card in card.json
kater explore card show --request-file card.json
# Then run the card on the warehouse and wait for its chart
kater explore card preview --request-file card.json
```

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--request-file <file>` | Required. The card as JSON, from a file. `-` reads stdin. It holds `namespace` and `card`, as [Cards](https://kater.ai/docs/cli-reference/explore/#cards) says. |

</div>

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

## What the request holds

- **`card`.** The card, from the tour or from `kater explore card create`.
- **`namespace`.** The card's own `workspace`.
- **`include_followups`.** Lists what to look at next. It is on unless you send `false`.
- **`include_fields`.** Also lists the model's fields that the card can add, each with its menu. It is off unless you send `true`.

## What it gives

- **`query_sql`.** The card's SQL. `query_document` is the query as a query file writes it, with its frontmatter.
- **`definition`.** The card's chart.
- **`followups`.** The questions the card leads to, each with the card that answers it. A card over another card's results offers a calculation over those results instead.
- **`picks` and `conditions`.** The card's fields and conditions, as the field picker lists them. `kater explore card edit` names them by position.

## See also

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

On this page

Examples
Options
What the request holds
What it gives
See also

Kater CLI Explore and try ideas explore card

kater explore card show

Shows a card's query, chart and next questions.

Use it to read a card’s SQL, fields and conditions before you change or run it. It plans the card again, and runs nothing on the warehouse.

Examples

# Show the SQL, chart and next questions of the card in card.json
kater explore card show --request-file card.json
# Then run the card on the warehouse and wait for its chart
kater explore card preview --request-file card.json

Options

Option	Description
`--request-file <file>`	Required. The card as JSON, from a file. `-` reads stdin. It holds `namespace` and `card`, as Cards says.

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

What the request holds

card. The card, from the tour or from kater explore card create.
namespace. The card’s own workspace.
include_followups. Lists what to look at next. It is on unless you send false.
include_fields. Also lists the model’s fields that the card can add, each with its menu. It is off unless you send true.

What it gives

query_sql. The card’s SQL. query_document is the query as a query file writes it, with its frontmatter.
definition. The card’s chart.
followups. The questions the card leads to, each with the card that answers it. A card over another card’s results offers a calculation over those results instead.
picks and conditions. The card’s fields and conditions, as the field picker lists them. kater explore card edit names them by position.

See also