@@ -23,14 +23,32 @@ indexed locally, and reviewed in Git like any other code change.
2323
2424## Quickstart
2525
26- ``` bash
26+ Give this prompt to your coding agent:
27+
28+ ``` text
29+ Install and set up CodeAlmanac for this repository.
30+
31+ Use the official installer:
2732curl -fsSL https://codealmanac.com/install.sh | sh
2833
29- # Choose one setup path:
30- codealmanac setup # Interactive setup
31- codealmanac setup --yes # Quick install; uses Codex as the AI runner
32- codealmanac setup --yes --runner claude # Quick install; uses Claude as the AI runner
34+ Then run `codealmanac setup` without `--yes`. Walk me through its interactive
35+ setup and wait for my choices instead of selecting defaults for me.
36+
37+ Initialize this repository if it does not already have an almanac/ directory,
38+ then verify the installation with `codealmanac doctor`.
39+ ```
40+
41+ Prefer to do it yourself?
3342
43+ ``` bash
44+ curl -fsSL https://codealmanac.com/install.sh | sh && codealmanac setup
45+ ```
46+
47+ See [ Install] ( #install ) and [ Setup] ( #setup ) for more options.
48+
49+ Once CodeAlmanac is set up:
50+
51+ ``` bash
3452cd your-repo
3553codealmanac init # Makes your wiki, if you don't have one
3654codealmanac search " getting started" # Shows matching wiki pages.
@@ -113,8 +131,17 @@ codealmanac setup --yes
113131codealmanac setup --yes --runner claude
114132```
115133
116- Setup installs local agent instructions plus the default local automation: sync,
117- Garden, and daily package update. It does not connect to a hosted service.
134+ Setup installs agent instructions for your chosen tools and three local macOS
135+ ` launchd ` jobs. Nothing runs in the cloud.
136+
137+ | Job | Default schedule | What it does |
138+ | --- | ---: | --- |
139+ | Sync | Every 5 hours | Scans recent Codex and Claude conversations and queues useful knowledge for the relevant registered wiki. |
140+ | Garden | Every 4 hours | Reviews every registered wiki for stale, duplicated, or poorly connected knowledge. |
141+ | Update | Every 24 hours | Checks for and installs CodeAlmanac CLI updates when it is safe to do so. |
142+
143+ These schedules run locally in the background. Use
144+ ` codealmanac automation status ` to see what is installed.
118145
119146If you don't have Codex or prefer Claude, use ` --runner claude ` .
120147
@@ -126,12 +153,19 @@ codealmanac setup --yes --target codex
126153codealmanac setup --yes --target claude
127154```
128155
129- Other setup flags :
156+ Customize automatic work during setup :
130157
131158``` bash
159+ # Change how often recent agent conversations are scanned
132160codealmanac setup --yes --sync-every 5h
161+
162+ # Do not install automatic transcript sync
133163codealmanac setup --yes --sync-off
164+
165+ # Do not install automatic wiki cleanup
134166codealmanac setup --yes --garden-off
167+
168+ # Do not install automatic CodeAlmanac updates
135169codealmanac setup --yes --no-auto-update
136170```
137171
@@ -184,20 +218,40 @@ should leave the wiki unchanged.
184218
185219## Sync And Automation
186220
187- ` sync ` scans local Claude and Codex transcript stores, finds conversations active
188- since the last completed sync, and queues ordinary local ingest runs.
221+ CodeAlmanac can keep registered wikis current without requiring you to remember
222+ maintenance commands.
223+
224+ ** Sync** scans local Codex and Claude transcript stores for conversations active
225+ since the previous completed sync. Conversations associated with registered
226+ repositories are queued as ordinary ingest jobs. Sync may decide that a
227+ conversation contains no durable knowledge and leave the wiki unchanged.
228+
229+ ** Garden** periodically queues a maintenance job for each registered wiki. It
230+ improves stale pages, weak links, topics, duplicated knowledge, and graph
231+ structure.
232+
233+ ** Update** keeps the locally installed CodeAlmanac CLI current. Scheduled
234+ updates are skipped when an update would be unsafe, such as while lifecycle
235+ work is active.
236+
237+ Automation is implemented with local macOS ` launchd ` jobs, not a hosted service
238+ or cloud sync. Logs are stored under ` ~/.codealmanac/logs/ ` .
189239
190240``` bash
191- codealmanac sync status --from codex
192- codealmanac sync --from codex --using codex
241+ # See installed schedules
242+ codealmanac automation status
243+
244+ # Change a schedule
193245codealmanac automation install sync --every 5h
246+ codealmanac automation install garden --every 4h
194247codealmanac automation install update --every 24h
195- codealmanac automation status
248+
249+ # Remove a schedule
250+ codealmanac automation uninstall sync
196251```
197252
198- Scheduled automation launches local ` sync ` , ` garden ` , or ` update ` commands with
199- explicit unattended policy. It is local scheduler state, not cloud sync.
200- Scheduler logs live under ` ~/.codealmanac/logs/ ` .
253+ Automation creates individual background runs. Inspect those runs separately
254+ with ` codealmanac jobs ` .
201255
202256## Jobs
203257
0 commit comments