Command Reference#

canary

canary - an application testing framework

canary [-hvqd] [--version] [-C path] [-p name] [--banner | --no-banner] [--color {auto,always,never}] [-f file]
   [-c path] [-e var=val] [--cache-dir CACHE_DIR]
   ...

Optional arguments

-h, --help

show this help message and exit

--version

show version and exit

-C path

Run as if canary was started in path instead of the current working directory.

-p name

Load given plugin module name (multi-allowed). To avoid loading of plugins, use the no: prefix.

-v

Increase console logging level by 1

-q

Decrease console logging level by 1

--banner, --no-banner

Print banner [default: False]

-d, --debug

Debug mode [default: None]

--color {auto,always,never}

When to color output [default: auto]

-f file

Read configuration settings from this file

-c path

Add the colon-separated path to test session’s configuration, e.g. -c debug:true

-e var=val

Add environment variable var to the testing environment with value val.

--cache-dir CACHE_DIR

Store job cache info in the given folder [default: .canary_cache/]

Subcommands