代码百科

Setup

Install global agent instructions for the local tools you use:

```bash

Interactive setup

codealmanac setup

Quick install with recommended defaults; uses Codex as the AI runner

codealmanac setup --yes

Quick install using Claude as the AI runner

codealmanac setup --yes --runner claude

Setup installs agent instructions for your chosen tools and three local macOS
`launchd` jobs. The jobs and all wiki work run locally.

| Job | Default schedule | What it does |
| --- | ---: | --- |
| Sync | Every 5 hours | Scans recent Codex and Claude conversations and queues useful knowledge for the relevant registered wiki. |
| Garden | Every 24 hours | Reviews every registered wiki for stale, duplicated, or poorly connected knowledge. |
| Update | Every 24 hours | Checks for and installs CodeAlmanac CLI updates when it is safe to do so. |

These schedules run locally in the background. Use
`codealmanac automation status` to see what is installed.

The final setup step asks about anonymous telemetry and recommends Yes so we can
see which commands work and where the CLI breaks. It sends controlled command
and lifecycle outcomes plus sanitized unhandled crashes under a random install
UUID. It never sends code, paths, arguments, queries, prompts, transcripts,
repository/run IDs, locals, or credentials; GeoIP is disabled. Choose No in
setup, pass `setup --no-telemetry`, set `telemetry.enabled` to `false`, or use
`DO_NOT_TRACK=1` at any time. Without a future login, the UUID profile has no
name or email.

If you don't have Codex or prefer Claude, use `--runner claude`.

`--target` only chooses which global agent instruction files to install; it does
not choose the AI runner:

Customize automatic work during setup:

Do not install automatic transcript sync

codealmanac setup --yes --sync-off

Do not install automatic wiki cleanup

codealmanac setup --yes --garden-off

Do not install automatic CodeAlmanac updates

codealmanac setup --yes --no-auto-update

To uninstall CodeAlmanac-owned local artifacts:

See installed schedules

codealmanac automation status

Quickstart

uv tool install codealmanac@latest
codealmanac setup

See Setup for configuration options.

Once CodeAlmanac is set up:

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.

Configuration

User config lives at:

~/.codealmanac/config.toml

The supported defaults are:

auto_commit = true

[harness]
default = "codex"
model = "gpt-5.5"

[automation.sync]
enabled = true
every = "5h"

[automation.garden]
enabled = true
every = "24h"

[automation.update]
enabled = true
every = "24h"

CLI flags still win over config.

Use codealmanac config set <key> <value> for normal changes. It applies automation changes to launchd immediately. Direct file edits are supported but must be followed by:

codealmanac config apply

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 true

Troubleshooting