A living wiki for your codebase, maintained by AI coding agents.
CodeAlmanac gives AI agents the context code alone cannot hold: why a system is shaped the way it is, what broke before, which invariants matter, and how workflows cross files and services. The wiki is plain markdown in your repo, indexed locally, and reviewed in Git like any other code change.
curl -fsSL https://codealmanac.com/install.sh | sh
codealmanac setup --yes
cd your-repo
codealmanac init # Makes your wiki, if you don't have one
codealmanac search "getting started" # Shows matching wiki pages.
codealmanac show getting-started # Opens one page in the terminal
codealmanac serve # Shows the wiki in local web viewer.With the install script:
curl -fsSL https://codealmanac.com/install.sh | shor directly:
uv tool install codealmanac@latestor:
python -m pip install codealmanacFrom this checkout:
uv sync
uv run codealmanac --helpRequires Python 3.12+.
Install global agent instructions for the local tools you use:
codealmanac setup --yes
codealmanac setup --yes --target codex
codealmanac setup --yes --target claudePlain setup installs local agent instructions plus the default local automation: sync, Garden, and daily package update. It does not connect to a hosted service.
--yes picks Codex as the AI runner. If you don't have Codex or prefer Claude:
codealmanac setup --yes --runner claudeOther setup flags:
codealmanac setup --yes --sync-every 5h
codealmanac setup --yes --sync-off
codealmanac setup --yes --garden-off
codealmanac setup --yes --no-auto-updateTo uninstall CodeAlmanac-owned local artifacts:
codealmanac uninstall --yesAgents and humans use the same local read commands:
codealmanac search "checkout timeout"
codealmanac search --mentions src/checkout/
codealmanac show checkout-flow
codealmanac topics
codealmanac health
codealmanac validateUse --wiki <name> to read another registered local wiki. By default,
commands target the exact current directory when it is a registered repository
root.
Lifecycle commands can ask a configured local agent harness to edit wiki pages.
They only allow source edits under almanac/.
codealmanac ingest README.md --using codex
codealmanac ingest github:pr:123 --using claude
codealmanac garden --using codexingest folds selected local material into the wiki. Inputs can include files,
directories, Git diffs, commit ranges, GitHub PRs or issues, URLs, and local
agent transcripts.
garden improves the existing wiki graph: stale pages, links, topics, weak
leads, duplicate pages, and unsupported claims.
No-op is valid. If the material adds no durable wiki knowledge, the harness should leave the wiki unchanged.
ingest and garden create queued runs and start a local worker. Use
codealmanac jobs and codealmanac jobs attach <run-id> to follow them.
sync scans local Claude and Codex transcript stores, finds conversations active
since the last completed sync, and queues ordinary local ingest runs.
codealmanac sync status --from codex
codealmanac sync --from codex --using codex
codealmanac automation install sync --every 5h
codealmanac automation install update --every 24h
codealmanac automation statusScheduled automation launches local sync, garden, or update commands with
explicit unattended policy. It is local scheduler state, not cloud sync.
Scheduler logs live under ~/.codealmanac/logs/.
Lifecycle runs are recorded under ~/.codealmanac/:
codealmanac jobs
codealmanac jobs show <run-id>
codealmanac jobs logs <run-id>
codealmanac jobs attach <run-id>
codealmanac jobs cancel <run-id>Run logs include source-resolution facts, harness events, safety errors, and terminal status.
CodeAlmanac currently supports local Codex app-server and Claude Agent SDK harnesses.
codex login
claude auth login
codealmanac doctorRead commands do not need provider credentials. Write-capable lifecycle commands need the selected harness to be available and authenticated.
With the default root:
your-repo/
|-- almanac/
| |-- README.md
| |-- topics.yaml
| |-- architecture/
| | |-- README.md
| | `-- indexer.md
| |-- decisions/
| | `-- local-first.md
| `-- guides/
| `-- setup.md
|-- src/
`-- ...
Markdown pages live directly under almanac/ in meaningful folders.
topics.yaml organizes pages across folders. README.md files act as landing
pages for their folder routes.
For auto-detection, a repository counts as a CodeAlmanac wiki when
almanac/topics.yaml and almanac/README.md exist.
Derived local state lives under ~/.codealmanac/:
~/.codealmanac/codealmanac.db
~/.codealmanac/repos/<repo-id>/index.db
The local database records repositories, runs, run events, worker locks, and
sync state. Per-repository runtime files contain derived indexes. They do not
belong in the committed almanac/ tree.
User config lives at:
~/.codealmanac/config.toml
Project config lives at:
almanac/config.toml
The first supported defaults are:
auto_commit = true
[harness]
default = "codex"CLI flags still win over config.
auto_commit means lifecycle prompts may tell the selected agent to use normal
Git commands for wiki source changes. CodeAlmanac does not stage files, split
diffs, or commit internally.
codealmanac setup --no-auto-commit
codealmanac config set auto_commit false
codealmanac config set auto_commit truecodealmanac serveThe viewer is read-only. It renders pages, search, topics, backlinks, and
file-reference navigation from local wiki data. By default it can switch across
available registered local wikis. Use codealmanac serve --wiki <name> to
narrow the viewer to one wiki.
The Codex CLI on this machine is broken or missing: the @openai/codex
package is installed but its native binary is gone (a common result of an
interrupted install or a Node version switch under nvm/volta/fnm). Verify
with:
codex --versionIf that fails with the same spawn ... ENOENT, reinstall the Codex CLI:
npm install -g @openai/codex
codex --version # confirm the binary runs
codex login status # confirm you are still signed inReinstalling does not sign you out: codex keeps its login under ~/.codex,
outside the npm package.
Or switch CodeAlmanac to the Claude harness instead:
codealmanac config set harness.default claudeThe same applies to harness claude failed errors: check
claude --version, reinstall the Claude Code CLI if broken, or switch the
default harness. codealmanac doctor reports harness availability.
This rewrite is local-only for now.
- Public command:
codealmanac - Repo wiki root:
almanac/only - Alternate repo wiki roots: none
- User state root:
~/.codealmanac/ - Runtime: Python 3.12+
- Storage: local markdown plus derived state under
~/.codealmanac/ - No hosted login/connect/upload commands.
- No public SDK or MCP package.
- No compatibility aliases.
- No alternate wiki roots.
- No hidden cloud write path.
- No second wiki command name.
This is the Python/PyPI product surface. Hosted integration can be added later around the same repo-owned wiki artifact, but it is not part of this release surface.