Compass basic command syntax
The compass.sh wrapper lives at ./projects/ores.compass/compass.sh.
Core commands:
- Search (find docs by topic):
compass.sh search "how do I create a runbook" - List (all docs of a type):
compass.sh list --type runbookcompass.sh list --type recipe - Show (read a doc by title or UUID prefix):
compass.sh show "How do I create a memory?" - Where (current sprint/story/task context):
compass.sh where - Story new (start a new story+branch in one step):
compass.sh story new --slug my_slug --title "Title" --description "..." --tags "tag1:tag2"For a hotfix branch (hotfix/<slug>instead offeature/<slug>):compass.sh story new --slug broken_thing --kind hotfix --title "Hotfix: ..." --description "..." --tags "hotfix:..." - Task new (add a task+branch to an existing story):
compass.sh task new --story <id-or-slug> --slug my_task --title "Title" - Task lifecycle (tables and journal are side-effects):
compass.sh add task --slug s --parent-dir <story-dir> --title T --description D --goal "..." --acceptance "..."compass.sh task start <slug> [--branch b]/compass.sh task done <slug> [--pr N] - PR lifecycle:
compass.sh pr sync [--push]/pr checks [--watch]/pr create --title "[c] D" --summary S --change C/pr merge [--force] - Review round:
compass.sh review pending [--since 24h]/review list <pr> [--detail]/review reply <pr> <id> "msg"/review resolve <pr> - Add (scaffold a new artefact — always requires
--slug,--title,--description,--tags; typesmemoryandrunbookalso require--parent-dir; typememoryalso requires--memory-subtype):compass.sh add runbook --slug hotfix --parent-dir doc/llm/runbooks --title "..." --description "..." --tags "..."compass.sh add memory --slug my_rule --parent-dir doc/llm/memory --title "..." --description "..." --memory-subtype feedbackcompass.sh add recipe --slug how_do_i_... --title "..." --description "..." --tags "..."
Why: Every session rediscovers the required flags by trial and error
(missing --parent-dir, missing --memory-subtype, etc.), wasting turns
and triggering user interruptions.
How to apply: Before calling any compass add command, check this memory
for the required flags. Do not guess — wrong flags fail silently or with
unhelpful errors.