Skip to main content

# kater explore definition show

Shows a shared model's Explore questions and saved plans.

{/* 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 the file's `revision` before you save it again with `kater explore definition generate`. It writes nothing.

## Examples

```bash
# Show the Explore questions and plans of the ad_reporting model
kater explore definition show --model semantic.ad_reporting --scope connections/snowflake_prod_connection/modeling
# Name the model with the request in source.json
kater explore definition show --request-file source.json
```

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--request-file <file>` | The request as JSON, from a file, in place of `--model` and `--scope`. `-` reads stdin. It holds the model's `namespace` and `source`, as [The request file](https://kater.ai/docs/cli-reference/explore/#the-request-file) shows. |
| `--model <model>` | The shared model, by its name or its typed address, such as `semantic.ad_reporting`. Give `--scope` with it: the connection's `modeling` folder. |

</div>

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

## What it gives

The saved Explore file: its `revision`, its `questions`, and the `queries`, `cards` and `use_cases` that plan them. A model with no saved file gives the questions its authors wrote, with no plans.

## See also

- [`kater explore definition`](https://kater.ai/docs/cli-reference/explore/definition/)
- [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 definition

kater explore definition show

Shows a shared model's Explore questions and saved plans.

Use it to read the file’s revision before you save it again with kater explore definition generate. It writes nothing.

Examples

# Show the Explore questions and plans of the ad_reporting model
kater explore definition show --model semantic.ad_reporting --scope connections/snowflake_prod_connection/modeling
# Name the model with the request in source.json
kater explore definition show --request-file source.json

Options

Option	Description
`--request-file <file>`	The request as JSON, from a file, in place of `--model` and `--scope`. `-` reads stdin. It holds the model’s `namespace` and `source`, as The request file shows.
`--model <model>`	The shared model, by its name or its typed address, such as `semantic.ad_reporting`. Give `--scope` with it: the connection’s `modeling` folder.

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

What it gives

The saved Explore file: its revision, its questions, and the queries, cards and use_cases that plan them. A model with no saved file gives the questions its authors wrote, with no plans.

See also