Skip to content

Command line

Exit codes are part of the contract, because these run in CI: 0 success, 1 the model or the run failed, 2 the invocation was wrong. A tool that returns 0 for "I could not tell" is one that turns a red build green.

varda

usage: varda [-h] {check,generate,rules,ext,importmap} ...

Dimensional modeling for LinkML.

positional arguments:
  {check,generate,rules,ext,importmap}
    check               validate a model
    generate            write artifacts from a model
    rules               list conformance rules
    ext                 describe active extensions
    importmap           print the LinkML import map

options:
  -h, --help            show this help message and exit

varda check

usage: varda check [-h] [--exempt CODE] [--strict] [--skip-imported] model

positional arguments:
  model

options:
  -h, --help       show this help message and exit
  --exempt CODE    skip a rule; repeatable
  --strict         fail on warnings and on exemptions that name no rule
  --skip-imported  do not report findings against classes another schema
                   declares; every rule still sees them

varda generate

usage: varda generate [-h] [--out OUT] [--schema SCHEMA] [--dialect NAME]
                      [--constraints LEVEL] [--only NAME] [--exempt CODE]
                      [--strict] [--force] [--skip-imported]
                      model

positional arguments:
  model

options:
  -h, --help           show this help message and exit
  --out OUT            output directory
  --schema SCHEMA      SQL schema name
  --dialect NAME       which database the DDL is for (duckdb, postgres,
                       snowflake, sqlserver)
  --constraints LEVEL  how much the database is asked to police (enforced,
                       asserted, none); weaker levels move the claims into
                       sql/assertions.sql
  --only NAME          run only this generator; repeatable
  --exempt CODE        skip a rule; repeatable
  --strict             stop on warnings as well as errors
  --force              generate even though the model does not conform
  --skip-imported      do not let findings against another schema's classes
                       stop the run; their tables are still emitted

varda rules

usage: varda rules [-h] [-v]

options:
  -h, --help     show this help message and exit
  -v, --verbose

varda ext

usage: varda ext [-h] [name]

positional arguments:
  name

options:
  -h, --help  show this help message and exit

varda importmap

usage: varda importmap [-h] [--json]

options:
  -h, --help  show this help message and exit
  --json      print it as JSON, for a generator's --importmap