Skip to main content

# kater explore preview show

Reads a card preview's state, and its chart's rows once it is complete.

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

It answers at once, and does not wait.

## Examples

```bash
# Read the state of the preview that preview.json names
kater explore preview show --request-file preview.json
# Stop it while it still runs
kater explore preview cancel --request-file preview.json
```

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--request-file <file>` | Required. The preview as JSON, from a file. `-` reads stdin. It holds `namespace`, the card's own `workspace`, and `id`, the preview's id from its start. |

</div>

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

## What it gives

`status` is `queued`, with its `queue_position`, or `compiling`, `waiting`, `running`, `complete`, `failed` or `cancelled`. A complete preview gives the chart's `definition` and its rows (`snapshot`). A failed one gives `failure`, as [kater explore card preview](https://kater.ai/docs/cli-reference/explore/card/preview/#states-and-failures) describes. An id that this process does not know is `preview_expired`.

## See also

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

On this page

Examples
Options
What it gives
See also

Kater CLI Explore and try ideas explore preview

kater explore preview show

Reads a card preview's state, and its chart's rows once it is complete.

It answers at once, and does not wait.

Examples

# Read the state of the preview that preview.json names
kater explore preview show --request-file preview.json
# Stop it while it still runs
kater explore preview cancel --request-file preview.json

Options

Option	Description
`--request-file <file>`	Required. The preview as JSON, from a file. `-` reads stdin. It holds `namespace`, the card’s own `workspace`, and `id`, the preview’s id from its start.

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

What it gives

status is queued, with its queue_position, or compiling, waiting, running, complete, failed or cancelled. A complete preview gives the chart’s definition and its rows (snapshot). A failed one gives failure, as kater explore card preview describes. An id that this process does not know is preview_expired.

See also