Skip to main content

# kater explore use-case list

Lists a shared model's questions, each with its id and whether it has a plan.

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

`kater explore use-case plan` takes a question's id and the answer's `revision`. It writes nothing.

## Examples

```bash
# List the questions of the ad_reporting model
kater explore use-case list --model semantic.ad_reporting --scope connections/snowflake_prod_connection/modeling
# Name the model with the request in source.json
kater explore use-case list --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`.

## Each question's status

- **`ready_to_preview`.** It has a plan, and its cards can run.
- **`needs_plan`.** It has no plan yet. `kater explore definition generate` with `--question` plans it.
- **`needs_setup`.** It has a plan that needs setup first. `requirements` says what.
- **`stale`.** The model is not current, so it must be built again first. `requirements` says why.

Each question also gives its text (`question`) and its `description`. `origin` says whether its authors wrote it or an AI model did. `query_count` and `card_count` say how many queries and cards its plan has.

## See also

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

On this page

Examples
Options
Each question’s status
See also

Kater CLI Explore and try ideas explore use-case

kater explore use-case list

Lists a shared model's questions, each with its id and whether it has a plan.

kater explore use-case plan takes a question’s id and the answer’s revision. It writes nothing.

Examples

# List the questions of the ad_reporting model
kater explore use-case list --model semantic.ad_reporting --scope connections/snowflake_prod_connection/modeling
# Name the model with the request in source.json
kater explore use-case list --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.

Each question’s status

ready_to_preview. It has a plan, and its cards can run.
needs_plan. It has no plan yet. kater explore definition generate with --question plans it.
needs_setup. It has a plan that needs setup first. requirements says what.
stale. The model is not current, so it must be built again first. requirements says why.

Each question also gives its text (question) and its description. origin says whether its authors wrote it or an AI model did. query_count and card_count say how many queries and cards its plan has.

See also