Skip to content
GitHub

Write a pack journey

Show readers how to move through your pack, stage by stage.

Add a JOURNEY.md file to your pack, and it is published as the pack’s journey page. Add one when the pack has at least two stages with distinct human decisions.

Create packs/<pack>/JOURNEY.md. Each stage is a ### heading followed by labelled lines in this order:

### 1. Draft the artifact
- **Agent does:** drafts the artifact from your input.
- **You decide:** whether the draft is ready to save.
- **Output:** a draft artifact or findings report.
- **State:** proposed-write

Every stage needs Output and State, and a stage that writes, publishes, deletes, or waits for a choice also needs You decide. The frontmatter, the settings block at the top, names the journey and lists the pack’s skills; Pack JOURNEY.md format lists every field.

Check the metadata, skill names, and states:

python tools/lint-pack-journeys.py

Build the journey page:

python tools/build-site.py --journeys-only

The page appears at /journeys/<journey_id>/, and JOURNEY.md is never installed with the pack.

Next, add credentials to a skill if the pack calls an authenticated service.