Skip to content

quox plan

Documented Checked against the CLI's current help and source. Not run end to end. Last checked on quoxcli 0.6.1, 2026-11-10.

All commands

QuoxPlan: roadmaps, streams, phases, plans, timeline (governed proxy to the QuoxPlan server)

CommandWhat it does
quox plan roadmaps [options]List roadmaps with status counts (archived roadmaps hidden unless --archived)
quox plan roadmapRoadmap-level operations (create, archive, unarchive a roadmap)
quox plan roadmap create [options]Create a roadmap (POST to the governed QuoxPlan proxy)
quox plan roadmap archive <roadmapId>Archive a roadmap: hide it from lists and search, refuse writes to its streams (history stays readable by id)
quox plan roadmap unarchive <roadmapId>Unarchive a roadmap: back in lists and search, writes allowed again
quox plan search [options] <text...>Search streams by text (id, name, notes, plan, phase titles)
quox plan list [options] [roadmap]Tier-grouped stream list (default roadmap: first by name)
quox plan focus [options] [roadmap]What matters now: everything blocked or waiting on a decision, the top 12 in flight, and a stale count (--all for the full focus list)
quox plan brief [options] [roadmap]One-screen roadmap brief: top priorities, what needs you, what to unblock, what moved, what is stale
quox plan watch [options] [roadmap]Live board: redraws the brief every interval and ticks off changes since you started watching (Ctrl-C exits)
quox plan show [options] <streamId>Stream detail: header, phases checklist, deps, plan (first 40 lines) and the newest 5 notes (--full for everything)
quox plan timeline [options] [roadmap]ASCII Gantt: dependency-sequenced schedule, critical path bold, blocked edges marked
quox plan followups [options] [roadmap]List follow-ups: roadmap-wide (default roadmap: first by name), or one stream with --stream
quox plan followupFollow-up writes: add a manual item, mark one done, or set its status
quox plan followup add [options] <streamId> <title...>Add a manual follow-up to a stream
quox plan followup done <followupId>Mark a follow-up DONE
quox plan followup status <followupId> <status>Set a follow-up’s status (OPEN, DONE, CANCELLED)
quox plan status [options] <id> <status>PATCH a stream status (COMPLETE requires --confirm-owner; never auto-confirmed)
quox plan note <id> <text...>Append a note to a stream’s timeline (append-only, never replaced)
quox plan phase <streamId> <verb> [rest...]Phase ops: “tick <seq>”, “untick <seq>”, “add <title>”, “rename <seq> <title>”, “remove <seq>”
quox plan plan [options] <id>Print raw plan markdown; --file writes a new version from a file or stdin; --edit opens $EDITOR (PUT on save if changed); --history lists versions
quox plan move <roadmap> <id> <position>Reprioritise a top-level stream to a 1-based position
quox plan add [options] <json>Create a new stream from a JSON object (id, name required)
quox plan update <id> <field> <value>Update a stream field (notes append; priority use move instead)
quox plan rename <oldId> <newId>Rename a stream id, cascading to depends_on/parent_id references
quox plan stats [roadmap]Roadmap statistics (streams, phase progress, tests shipped)
quox plan completed [roadmap]List completed streams