Command-line interface¶
jacquard is controlled via a command-line interface.
Users and settings¶
show defaults¶
show settings for user
usage: jacquard show defaults [-h] [user]
Positional Arguments¶
| user | user to show settings for |
show user¶
show settings for user
usage: jacquard show user [-h] [user]
Positional Arguments¶
| user | user to show settings for |
set-default¶
set (or clear) a default setting
usage: jacquard set-default [-h] [-d] [--add] setting [value]
Positional Arguments¶
| setting | setting key |
| value | value to set |
Named Arguments¶
| -d, --delete | clear the associated value Default: False |
| --add | skip any keys which already exist in the database Default: False |
override¶
control user overrides
usage: jacquard override [-h] [-d] user setting [value]
Positional Arguments¶
| user | user to override for |
| setting | setting key |
| value | value to set |
Named Arguments¶
| -d, --delete | clear the associated value Default: False |
rollout¶
partially roll out a feature
usage: jacquard rollout [-h] (--rollback | --commit | --percent PERCENT)
[--with-tag WITH_TAG] [--without-tag WITHOUT_TAG]
setting value
Positional Arguments¶
| setting | setting name |
| value | value to roll out |
Named Arguments¶
| --rollback | roll back to the defaults Default: False |
| --commit | commit to this option Default: False |
| --percent | do a staged rollout Default: 0 |
| --with-tag | tags to rollout to Default: [] |
| --without-tag | tags to exclude from rollout Default: [] |
Experiments¶
list experiments¶
list all experiments
usage: jacquard list experiments [-h] [--detailed] [--active]
Named Arguments¶
| --detailed | whether to show experiment details in the listing Default: False |
| --active | only show active experiments Default: False |
load-experiment¶
load an experiment definition from a file
usage: jacquard load-experiment [-h] [--skip-launched] file [file ...]
Positional Arguments¶
| file | experiment definition |
Named Arguments¶
| --skip-launched | |
do not load or error on launched experiments Default: False | |