Doc Show
Table of Contents
1. When to use this skill
Reading the current state of something and changing nothing: one document, the sprint, the fleet, the journal, the services, a PR's checks, a backlog bucket. Showing is one procedure over many targets, so it is one skill and a table.
2. How to use this skill
- Name the target. What do you want the state of? Find its row in the
table below. A target with no row is still reachable:
compass --helplists every command, and the read-only ones follow the same shape. - Run its command and read the output. Each prints state and stops. None of them changes anything, so running one to decide what to do next is always safe.
- Follow the printed hints. Compass output names the next command to
run — a
compass showline under a search result,compass services startunder a stopped fleet. Prefer the hint over guessing.
2.1. Targets
One row per read-only command. Each shows state and changes nothing, so any of them is safe to run while deciding what to do next.
| Command | Shows |
|---|---|
compass show |
Show one doc by UUID/prefix: metadata, blurb, in/out links |
compass search |
Search your notes |
compass list |
List/filter docs (–regex/–tag/–type/–under/…) |
compass where |
Show where we are: current version, sprint, in-flight work |
compass fleet |
Show what every git worktree is doing: branch, story, task, PR |
compass journal |
Read/write the per-worktree session journal |
compass timeline |
'timeline generate [–since 20m]', 'timeline now', 'timeline snapshot [–since 20m]', 'timeline show [-n N]' |
compass heading |
Suggest the next work item: ranked by priority from sprint state, fleet, and backlog |
compass bearings |
Cold-start orientation: identity, where, last session, recipes, memories |
compass inbox |
List captures in the product backlog inbox/ |
compass next |
List captures in the product backlog next/ |
compass deferred |
List captures in the product backlog deferred/ |
compass discarded |
List captures in the product backlog discarded/ |
compass sprint status |
the sprint's stories grouped by state |
compass sprint audit |
drift between story files and the sprint table |
compass story status |
one story's tasks and their states |
compass services status |
which services run, which stopped or went missing |
compass pr checks |
CI state on a pull request |
compass test results |
the last ctest run |
compass review list |
the review comments on a pull request |
compass env list |
the provisioned worktrees |
compass db sql |
whatever the query returns |
compass skills report |
skill-selection quality over a window |
3. Recipes
- How do I search docs with compass? — finding a document's UUID first.
4. Reference
- Skill architecture — why a uniform verb is one skill plus a type table.