@@ -18,6 +18,15 @@ dead-ends inside them never compile into anything the next session can
1818reference. CodeAlmanac is that reference layer: a wiki that lives in your
1919repository, written for your agents, and kept up to date from the work itself.
2020
21+ ## At a glance
22+
23+ - Public command: ` codealmanac `
24+ - Python 3.12+
25+ - Default repo wiki root: ` almanac/ `
26+ - Custom repo wiki roots: any safe repo-relative directory via ` --root `
27+ - User state root: ` ~/.codealmanac/ `
28+ - Cloud commands: ` setup ` , ` login ` , ` whoami ` , ` logout ` , ` capture ` .
29+
2130## Get started
2231
2332Install the CLI (Python 3.12+):
@@ -32,6 +41,8 @@ uv tool install codealmanac
3241``` bash
3342codealmanac init # build the first wiki for this repo
3443codealmanac local setup # keep it updating from your commits
44+ codealmanac search " getting"
45+ codealmanac show getting-started
3546```
3647
3748** With your team (cloud)** — one shared wiki, updated from everyone's
@@ -55,10 +66,11 @@ your-repo/
5566|-- almanac/
5667| |-- README.md # this repo's notability bar and conventions
5768| |-- topics.yaml # topic graph
58- | `-- pages/
59- | |-- checkout-flow.md
60- | |-- stripe-webhook-deadlock.md
61- | `-- jwt-vs-sessions.md
69+ | |-- manual/ # packaged guidance copied for agents
70+ | |-- pages/
71+ | | |-- checkout-flow.md
72+ | | |-- stripe-webhook-deadlock.md
73+ | | `-- jwt-vs-sessions.md
6274|-- src/
6375`-- ...
6476```
@@ -67,6 +79,10 @@ Every page is one stable concept — a flow, a decision, a gotcha — linked int
6779a topic graph with ` [[wikilinks]] ` . Browse it locally with `codealmanac
6880serve` , or in the cloud with ` codealmanac open`.
6981
82+ A folder counts as a CodeAlmanac wiki only when it has both ` topics.yaml ` and ` pages/ ` .
83+ Derived local state appears when commands need it: ` index.db ` and
84+ user-level job records are runtime state, not part of the init scaffold.
85+
7086## Principles
7187
72881 . ** Written for your agents.** The primary reader is the AI agent working in
@@ -104,17 +120,27 @@ model and need no credentials.
104120| ---| ---|
105121| ` codealmanac init ` | Build the first wiki for the current repo. |
106122| ` codealmanac local setup ` | Configure local self-updating: branch policy + git hooks. |
123+ | ` codealmanac local setup --branch main ` | Configure a specific maintained branch locally. |
107124| ` codealmanac local update ` | Run a local wiki update now. |
125+ | ` codealmanac local update --using codex ` | Run a local update with Codex. |
126+ | ` codealmanac local triggers enable dev --delivery commit ` | Maintain a branch locally. |
127+ | ` codealmanac local jobs list ` | Inspect local update jobs. |
108128| ` codealmanac search ` / ` show ` / ` topics ` / ` health ` | Query the wiki. |
109129| ` codealmanac serve ` | Local wiki viewer. |
110130| ` codealmanac setup ` | Cloud sign-in plus agent instructions. |
111- | ` codealmanac capture enable\|status\|disable ` | Manage session capture. |
131+ | ` codealmanac login ` / ` whoami ` / ` logout ` | Manage cloud auth. |
132+ | ` codealmanac capture status ` | Show capture status. |
133+ | ` codealmanac capture enable --target codex ` | Enable Codex session capture. |
134+ | ` codealmanac capture disable ` | Disable capture hooks. |
112135| ` codealmanac repo triggers enable <branch> --delivery pr\|commit ` | Choose how cloud updates land. |
113136| ` codealmanac runs list\|show\|logs ` | Inspect cloud update runs. |
114137| ` codealmanac doctor ` | Check install, auth, and wiki health. |
115138
116139Run ` codealmanac <command> --help ` for the full flag surface.
117- ` codealmanac uninstall --yes ` removes setup-owned local artifacts.
140+ Local schedules stay behind explicit local or automation commands.
141+ ` codealmanac uninstall --yes ` removes setup-owned local artifacts;
142+ ` codealmanac uninstall --yes --keep-automation ` leaves local scheduled
143+ automation in place.
118144
119145## Privacy
120146
0 commit comments