CLI
You run ShepAIrd from the terminal. Full commands look like shepaird memory add and shepaird index run. The daily path is context search, brief, and memory.
How commands are shaped
Noun, then verb
shepaird [flags] <noun> <verb> [args]
Humans get a readable terminal. Scripts and agents pass --json for structured output. Writes can be previewed with --dry-run before anything is saved.
Daily commands
- shepaird init
- Create local data and start ShepAIrd on this machine.
- shepaird index run
- Build or refresh the map of the codebase.
- shepaird context search
- Ask a question. Results cite files and lines, from code and memory together.
- shepaird memory add
- Save a finding. Point it at a file and line with --cite.
- shepaird brief
- Print the short briefing the next session should open with.
- shepaird recall
- Look up what was already learned, without re-asking the whole codebase.
Useful flags
- --json
- Machine-readable output for scripts and agents.
- --explain
- Show how the answer was built, and what was skipped.
- --home
- Use a different data folder than the default.
- --cite
- Point a memory at a file and line.
- --dry-run
- Preview a write without saving it.
Health
doctor checks that this machine is ready. doctor fix repairs common problems. Run them when something looks off, or after a new install.
Check, then repair
shepaird doctor shepaird doctor fix