Skip to main content

# kater test list

Lists tests, with how each one last ran, and who added it and when.

{/* 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 find the tests that failed, that are still drafts, or that must run again. It reads the records on this machine, and it runs and compiles nothing.

## Examples

```bash
# List the tests of the shared ad_reporting model
kater test list --model semantic.ad_reporting
# List only the tests whose last run failed
kater test list --model semantic.ad_reporting --failing
# List the drafts that someone must still check
kater test list --model semantic.ad_reporting --drafts
# List every test of the connection that must run again
kater test list --connection snowflake_prod_connection --stale
```

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--connection <name>` | The connection whose tests to list, by its folder name under `connections/`. Leave it out when only one connection has the `--model`. |
| `--model <model>` | Lists only this model's tests, such as `semantic.ad_reporting`. |
| `--failing` | Lists only the tests whose last run failed. |
| `--drafts` | Lists only the drafts, which nobody checked yet. |
| `--stale` | Lists only the tests that must run again. Their last compile differs from their last pass, they never passed, or their text, answer or model changed since. |

</div>

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

## What it prints

For each model's test file, it gives how many tests the file has and when they last ran. It then counts the tests that pass, fail, are drafts, never ran or are stale. Then each test has one line: its last status, its name, its kind of answer, and who added it and when.

To see whether a model is ready to hand off, use [`kater test readiness`](https://kater.ai/docs/cli-reference/test/readiness/).

## See also

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

On this page

Examples
Options
What it prints
See also

Kater CLI Build and check test

kater test list

Lists tests, with how each one last ran, and who added it and when.

Use it to find the tests that failed, that are still drafts, or that must run again. It reads the records on this machine, and it runs and compiles nothing.

Examples

# List the tests of the shared ad_reporting model
kater test list --model semantic.ad_reporting
# List only the tests whose last run failed
kater test list --model semantic.ad_reporting --failing
# List the drafts that someone must still check
kater test list --model semantic.ad_reporting --drafts
# List every test of the connection that must run again
kater test list --connection snowflake_prod_connection --stale

Options

Option	Description
`--connection <name>`	The connection whose tests to list, by its folder name under `connections/`. Leave it out when only one connection has the `--model`.
`--model <model>`	Lists only this model’s tests, such as `semantic.ad_reporting`.
`--failing`	Lists only the tests whose last run failed.
`--drafts`	Lists only the drafts, which nobody checked yet.
`--stale`	Lists only the tests that must run again. Their last compile differs from their last pass, they never passed, or their text, answer or model changed since.

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

What it prints

For each model’s test file, it gives how many tests the file has and when they last ran. It then counts the tests that pass, fail, are drafts, never ran or are stale. Then each test has one line: its last status, its name, its kind of answer, and who added it and when.

To see whether a model is ready to hand off, use kater test readiness.

See also