Skip to content

host

usage: cox host [-h] [--profile PROFILE]
                {add,list,drain,remove,activate,capacity,beat,login,doctor,sync} ...

The hosts table: lane hosts, their capacity, versions and login.

positional arguments:
  {add,list,drain,remove,activate,capacity,beat,login,doctor,sync}
    add                 add or update a host in the table
    list                one line per host: state, capacity, beat age, login
    drain               stop launching on a host; its live lanes finish
    remove              delete a drained idle host from the hosts table
    activate            make a host a lane host again
    capacity            change only a host's capacity, leaving ssh, weight and
                        capabilities as they are
    beat                record this machine's versions and claude login in the
                        table
    login               store a host's login state without touching its beat
                        time
    doctor              the table's line for a host, then its doctor over ssh
    sync                bring a host's checkouts to the commits this machine
                        runs (fetch, then fast-forward or check out)

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

examples:
  cox host add host-a --ssh host-a --capacity 8
  cox host list
  cox host beat
  cox host sync host-a

add

usage: cox host add [-h] --ssh SSH --capacity CAPACITY [--weight WEIGHT]
                    [--capabilities CAPABILITIES]
                    name

positional arguments:
  name

options:
  -h, --help            show this help message and exit
  --ssh SSH
  --capacity CAPACITY   lanes the host may run at once
  --weight WEIGHT       share of new placements
  --capabilities CAPABILITIES
                        comma-separated, e.g. go,rust

list

usage: cox host list [-h]

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

drain

usage: cox host drain [-h] name

positional arguments:
  name

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

remove

usage: cox host remove [-h] [--dry-run] name

positional arguments:
  name

options:
  -h, --help  show this help message and exit
  --dry-run   print the row that would be removed; write nothing

activate

usage: cox host activate [-h] name

positional arguments:
  name

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

capacity

usage: cox host capacity [-h] [--json] name n

positional arguments:
  name
  n           lanes the host may run at once; 0 suspends new placement

options:
  -h, --help  show this help message and exit
  --json      print the row as JSON

beat

usage: cox host beat [-h] [name]

positional arguments:
  name        default: this machine's hostname

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

login

usage: cox host login [-h] [--reason REASON] [--failures FAILURES]
                      name {true,false,none}

positional arguments:
  name
  {true,false,none}

options:
  -h, --help           show this help message and exit
  --reason REASON      why the check failed
  --failures FAILURES  consecutive failed checks

doctor

usage: cox host doctor [-h] name

positional arguments:
  name

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

sync

usage: cox host sync [-h] name

positional arguments:
  name

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