Skip to content

settings

usage: cox settings [-h] {get,set} ...

The cartridge and profile settings, with where each lives and whether git tracks it.

positional arguments:
  {get,set}
    get       print every setting, grouped by section; unset keys appear as
              built-in defaults, which set can override
    set       change one setting: print the diff and write the file; --commit
              also commits a git-tracked cartridge

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

examples:
  cox settings get
  cox settings get --json
  cox settings set cartridge policy.dispatch.max_in_flight 4 --dry-run

get

usage: cox settings get [-h] [--json] [--profile PROFILE]

options:
  -h, --help         show this help message and exit
  --json
  --profile PROFILE

set

usage: cox settings set [-h] [--dry-run] [--commit] [--profile PROFILE]
                        {cartridge,profile,host} key value

positional arguments:
  {cartridge,profile,host}
  key
  value

options:
  -h, --help            show this help message and exit
  --dry-run
  --commit              commit the changed cartridge file in git; profile
                        files are never committed
  --profile PROFILE