Skip to content

CLI Overview

All commands share two common flags:

  • --project — path to the clair project root (default: .)
  • --env — environment name from ~/.clair/environments.yml (default: CLAIR_ENV or dev)

Commands

Command Description Snowflake connection?
clair init Create a new project and configure Snowflake connection No
clair compile Resolve DAG and write SQL to _clairtifacts/ Optional (for routing)
clair run Execute Trouves against Snowflake in dependency order Yes
clair test Run data quality tests against Snowflake Yes
clair dag Print the dependency graph as an indented tree No
clair docs Start a local web UI showing the DAG and documentation No
clair clean Remove compiled artifacts from _clairtifacts/ No

Environment Variables

Variable Default Description
CLAIR_ENV dev Active environment name. Equivalent to passing --env on every command. --env takes precedence if both are set.
CLAIR_LOG_FORMAT (text) Set to json to emit structured JSON logs. Useful in CI/CD pipelines and container environments that ingest JSON logs.

Help

clair --help
clair run --help
clair compile --help