Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Set up

kater debug

Checks the setup that each command runs on, one line each, as dbt debug does.

Run it when a command cannot reach Kater or the warehouse, or to see which profile and target a command uses. It changes nothing.

Examples

Terminal window
# Check the setup
kater debug
# Check the setup of the prod target
kater debug --target prod
# Get the checks as one JSON document
kater debug --json

Options

It also takes the global options --json and --help.

What it checks

  1. The CLI’s version, and the Python that runs it.
  2. The profile and the target, and the profiles.yml they come from.
  3. The project file, kater_project.yml, in this folder or a folder above it.
  4. The Kater API: that it answers at the target’s api_url, and that it accepts your sign-in.
  5. Each warehouse connection of the project: a select 1 through the Kater API, with 30 seconds at most. A connection that Kater stores no credential for shows SKIP.
  6. The git state of the project: its branch, and how many files changed.
  7. The size of the compile cache.

Each line ends with OK, ERROR or SKIP, and an error has the next step under it. The last line says “All checks passed!” or how many checks failed. The command exits 1 when a check fails.

See also