usage: cox setup [-h] [--profile PROFILE] {doctor,install,migrate,store} ...
Does this machine's profile actually work.
positional arguments:
{doctor,install,migrate,store}
doctor check this machine's profile against what it needs
install sync the checkout's venv, install cox and write a
profile for this machine
migrate plan moving this host to the one monorepo checkout;
--apply migrates
store choose files or a shared store for run records
options:
-h, --help show this help message and exit
--profile PROFILE
examples:
cox setup doctor --profile PATH
cox setup install --root PATH --team NAME --workspace PATH
doctor
usage: cox setup doctor [-h] [--profile PROFILE] [--repo REPO] [--json]
[--host HOST]
options:
-h, --help show this help message and exit
--profile PROFILE
--repo REPO target repo to check for a .agent/cartridge.yaml overlay
(default: cwd)
--json
--host HOST run the doctor on this lane host from lane_hosts; --json
is ignored
install
usage: cox setup install [-h] [--root ROOT] --team TEAM
[--workspace WORKSPACE] [--home HOME]
[--provider-profile PROVIDER_PROFILE]
[--skills-root SKILLS_ROOT] [--assume {a,r}]
[--plugins] [--hook] [--force-profile] [--dry-run]
[--window-ceiling-usd WINDOW_CEILING_USD]
[--weekly-ceiling-usd WEEKLY_CEILING_USD]
options:
-h, --help show this help message and exit
--root ROOT
--team TEAM
--workspace WORKSPACE
--home HOME absolute path of the coxswain home; used when --root
is omitted
--provider-profile PROVIDER_PROFILE
--skills-root SKILLS_ROOT
--assume {a,r}
--plugins
--hook
--force-profile
--dry-run
--window-ceiling-usd WINDOW_CEILING_USD
write spend: window_ceiling_usd into the profile
--weekly-ceiling-usd WEEKLY_CEILING_USD
write spend: weekly_ceiling_usd into the profile
migrate
usage: cox setup migrate [-h] [--home HOME] [--dry-run] [--apply] [--hosts]
[--finish] [--old-root PATH] [--to VERSION]
options:
-h, --help show this help message and exit
--home HOME absolute path of the coxswain home to migrate to
--dry-run same as the default: print the plans; change nothing
--apply execute the plans; without it the command only prints them
--hosts with --apply, also run the host steps; use it on the
chair's machine
--finish own mode, after every host migrated: rewrite queue paths,
remove old links
--old-root PATH with --finish, the old checkout root when no marker names
it
--to VERSION the release the umbrella checkout becomes; default the
newest
store
usage: cox setup store [-h] [--store STORE] [--host HOST] [--port PORT]
[--database DATABASE] [--user USER] [--bucket BUCKET]
[--endpoint ENDPOINT] [--region REGION]
[--password-env PASSWORD_ENV]
[--access-key-env ACCESS_KEY_ENV]
[--secret-key-env SECRET_KEY_ENV] [--dry-run]
[--allow-unreachable]
{switch} ...
positional arguments:
{switch}
switch copy the run store and traces to the other backend,
then record store.mode
options:
-h, --help show this help message and exit
--store STORE files or shared; asked in a terminal when omitted,
else files
--host HOST shared: Postgres host
--port PORT shared: Postgres port
--database DATABASE shared: Postgres database
--user USER shared: Postgres user
--bucket BUCKET shared: S3 bucket for traces
--endpoint ENDPOINT shared: S3 endpoint URL
--region REGION shared: S3 region
--password-env PASSWORD_ENV
shared: NAME of the variable holding the Postgres
password
--access-key-env ACCESS_KEY_ENV
shared: NAME of the variable holding the S3 access key
id
--secret-key-env SECRET_KEY_ENV
shared: NAME of the variable holding the S3 secret key
--dry-run validate and print; write and probe nothing
--allow-unreachable exit 0 even when a probe fails