Skip to content

route

usage: cox route [-h]
                 {context,status,file,priority,pull,lint,groups,drift,import,paths,store-fill,approve,decline,edit,remove,requeue,chair,sync,launch} ...

File work for the harness, and see what is queued or running.

positional arguments:
  {context,status,file,priority,pull,lint,groups,drift,import,paths,store-fill,approve,decline,edit,remove,requeue,chair,sync,launch}
    context             the routing profile's resolved context
    status              what is queued or running for this profile
    file                file a new ticket for the harness
    priority            move an initiative up or down the launch order
    pull                file intake tickets from a source, once per link
    lint                static ticket lint over a filed initiative, work-
                        shape.md §3
    groups              print the newest plans/intake-groups/<date>.md file,
                        work-shape.md §5
    drift               items whose store state and file state differ
    import              load the current work item files into the store's
                        work_items table
    paths               rewrite recorded repo paths to the tilde form, dry run
                        first
    store-fill          fill the store's work_items from the workspace files
    approve             approve a draft initiative's todo tickets: todo
                        becomes ready
    decline             decline a draft initiative: its todo tickets become
                        dropped
    edit                change a queued intake, an initiative or a task ticket
    remove              remove a queued intake or an initiative that has no
                        live run
    requeue             requeue the intake of an initiative that has no live
                        tasks
    chair               the chair lock for the landing loop (runs/chair.json)
    sync                mirror the work store onto the profile's tracker
    launch              run one of the harness's graphs directly

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

examples:
  cox route launch epic --initiative work/<id> --repo PATH
  cox route status --profile PATH

context

usage: cox route context [-h] [--profile PROFILE] [--json]

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

status

usage: cox route status [-h] [--profile PROFILE] [--json] [--all]

options:
  -h, --help         show this help message and exit
  --profile PROFILE
  --json
  --all              every run, not only live and recent ones

file

usage: cox route file [-h] [--profile PROFILE] [--repo REPO] [--title TITLE]
                      [--body BODY] [--phase PHASE] [--intake]
                      [--from-intake FROM_INTAKE] [--force]

options:
  -h, --help            show this help message and exit
  --profile PROFILE
  --repo REPO
  --title TITLE
  --body BODY
  --phase PHASE
  --intake
  --from-intake FROM_INTAKE
                        link and file an existing intake file's initiative,
                        then retire it
  --force               file an intake even when its title duplicates an open
                        issue

priority

usage: cox route priority [-h] [--profile PROFILE] [--set N | --up | --down |
                          --top | --bottom]
                          [initiative]

positional arguments:
  initiative         required with a flag; omit it to list the open queue

options:
  -h, --help         show this help message and exit
  --profile PROFILE
  --set N            write N on every item
  --up               pass the nearest higher open initiative
  --down             pass the nearest lower open initiative
  --top              one above every other open initiative
  --bottom           one below every other open initiative

pull

usage: cox route pull [-h] [--profile PROFILE] [--source SOURCE] [--dry-run]

options:
  -h, --help         show this help message and exit
  --profile PROFILE
  --source SOURCE    one source; default every source in the profile
  --dry-run

lint

usage: cox route lint [-h] [--repo REPO] initiative_dir

positional arguments:
  initiative_dir

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

groups

usage: cox route groups [-h] [--profile PROFILE]

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

drift

usage: cox route drift [-h] [--profile PROFILE] [--json]

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

import

usage: cox route import [-h] [--profile PROFILE] [--workspace WORKSPACE]

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

paths

usage: cox route paths [-h] [--profile PROFILE] [--workspace WORKSPACE]
                       [--apply] [--move OLD NEW]

options:
  -h, --help            show this help message and exit
  --profile PROFILE
  --workspace WORKSPACE
  --apply               write the changes; the default only lists them
  --move OLD NEW        swap repo prefix OLD for NEW

store-fill

usage: cox route store-fill [-h] [--profile PROFILE] [--workspace WORKSPACE]

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

approve

usage: cox route approve [-h] [--task TASK] [--by BY] [--profile PROFILE]
                         initiative

positional arguments:
  initiative

options:
  -h, --help         show this help message and exit
  --task TASK        approve this one task only
  --by BY            who approves; default the OS user
  --profile PROFILE

decline

usage: cox route decline [-h] --reason REASON [--by BY] [--profile PROFILE]
                         initiative

positional arguments:
  initiative

options:
  -h, --help         show this help message and exit
  --reason REASON
  --by BY            who declines; default the OS user
  --profile PROFILE

edit

usage: cox route edit [-h] [--title TITLE] [--body BODY]
                      [--body-file BODY_FILE] [--repo REPO]
                      [--surfaces SURFACES] [--state STATE] [--dry-run]
                      [--profile PROFILE]
                      id

positional arguments:
  id                    a queued intake, an initiative or a task ticket

options:
  -h, --help            show this help message and exit
  --title TITLE
  --body BODY
  --body-file BODY_FILE
  --repo REPO
  --surfaces SURFACES   task ticket only: comma-separated paths that replace
                        the list
  --state STATE         task ticket only: ready, approved, done or dropped;
                        never backward
  --dry-run             print the diff and write nothing
  --profile PROFILE

remove

usage: cox route remove [-h] --reason REASON [--by BY] [--dry-run]
                        [--profile PROFILE]
                        id

positional arguments:
  id                 a queued intake or an initiative

options:
  -h, --help         show this help message and exit
  --reason REASON
  --by BY            who removes; default the OS user
  --dry-run          print the plan and write nothing
  --profile PROFILE

requeue

usage: cox route requeue [-h] [--dry-run] [--profile PROFILE] id

positional arguments:
  id                 an intake or an initiative

options:
  -h, --help         show this help message and exit
  --dry-run          print the plan and write nothing
  --profile PROFILE

chair

usage: cox route chair [-h] {take,extend,beat,release,status,clear,chat} ...

positional arguments:
  {take,extend,beat,release,status,clear,chat}
    take                take the chair lock if no live chair holds it
    extend              move the end of the chair takeover this session holds
    beat                refresh the chair lock's heartbeat
    release             release the chair lock this session holds
    status              the chair lock's holder and computed state
    clear               remove the chair lock file, refusing a live holder
                        unless --force
    chat                append to or read the leader chat thread
                        (runs/leader.chat.jsonl)

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

sync

usage: cox route sync [-h] [--profile PROFILE] [--item ITEM]
                      [--project PROJECT] [--workspace WORKSPACE] [--dry-run]

options:
  -h, --help            show this help message and exit
  --profile PROFILE
  --item ITEM
  --project PROJECT
  --workspace WORKSPACE
  --dry-run

launch

usage: cox route launch [-h] {epic,decompose,rescue,cos,sweep} ...

positional arguments:
  {epic,decompose,rescue,cos,sweep}
    epic                launch the epic graph against a filed initiative
    decompose           launch the decompose graph against an idea
    rescue              launch the rescue graph against a task
    cos                 launch the cos graph
    sweep               launch the sweep graph against an idea

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