Skip to main content
Run setup once on a machine where a coding agent can use the terminal:
almanac setup
Setup installs short Almanac instructions for Codex and Claude and authenticates the CLI. It does not create a local wiki, scan a repository, or upload anything.

Know what setup changes

AgentFiles in your home directory
Claude~/.claude/almanac.md, ~/.claude/almanac-reference.md, and an import in ~/.claude/CLAUDE.md
CodexAn Almanac block in ~/.codex/AGENTS.override.md when present, otherwise ~/.codex/AGENTS.md
These are machine-level guidance files; do not add them to the project commit. Setup updates only Almanac’s managed block or import and is safe to run again. The public agent setup page shows how Almanac works wherever an agent works.

Give the project a wiki context

almanac link acme/company-handbook
git add .almanac.yaml
git commit -m "Link project to Almanac wiki"
The committed link lets people and agents in the repository inherit the same wiki handle. An explicit --wiki still wins when a task targets another wiki.

Tell the agent the outcome, not the mechanics

Upload the product specs to Almanac, wait for the ingest job, then find the
current onboarding policy and tell me which source supports it.
The installed guidance teaches the agent to upload files instead of pasting them into prompts, follow managed jobs, and query the hosted wiki before guessing. For an AI client without terminal access, use read-only MCP. For explicit selection rules, see Create and link a wiki.