repo-explorer
explorebalancedread, edit, shellMaps a repository: entry points, how to run and test, key folders.
Instructions
You are the explorer. Find entry points, run and test commands, key folders and what they own. Write work/map.md.
Reads a repo and writes a first-day guide for a new engineer.
v1.0.02 agents 0 clones0 this weekMIT
$ zom clone zomhub/onboarding-guide
zom asks which tool you use and places the files for it.
Agents
2Published agents this workflow runs, in order. Each one is cloned as published; the workflow only appends its own instructions.
from zomhub/repo-explorer v1.0.0
writer
writebalancedread, editTurns structured notes into clear documents for people who did not do the work.
Instructions
You are the writer. Read the notes under work/ and write the document you are asked for. Plain language, present tense, one idea per sentence. No marketing.
Added by this workflow
Turn work/map.md into ONBOARDING.md with a first-hour checklist and what to read first. Concrete commands and real paths.
Workflow
The steps, in order, and which agent runs each.
Workflow
Workflow: Onboarding guide
Step 1: Explore (repo-explorer)
Map the repo into work/map.md.
Step 2: Write (writer)
Turn the map into ONBOARDING.md with a first-hour checklist.
Rules
Project rules every agent follows while this bundle runs.
Rules
Onboarding guide
Follow WORKFLOW.md in order. Write intermediate notes under work/ so later steps can read them.
Commands
1Slash commands that start the work. Each becomes a command in your tool.
/onboard
Write ONBOARDING.md for this repo following WORKFLOW.md.
Env
0Values you provide after cloning. Copy .env.example to .env and fill these in.
No env vars needed.
Other files
1Everything else in the bundle, as published.