github/codegraph
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): init indexes by default (drop -i) + bold auto-sync guarantee (#842)

Browse Source 
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Colby Mchenry
2026-06-12 17:57:50 -05:00
committed by GitHub
co-authored by Claude Opus 4.8
parent 3286e9f104
commit eed0b5ae20
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -4
View File
@@ -77,10 +77,13 @@ codegraph install
```bash
cd your-project
codegraph init -i
codegraph init
```
<sub>`codegraph init` just creates the local `.codegraph/` index directory; adding `-i` (`--index`) also builds the initial graph in the same step. Without `-i`, run `codegraph index` afterwards to populate it.</sub>
<sub>`codegraph init` creates the local `.codegraph/` directory and builds the full graph in the same step — one command, done.</sub>
**From that moment the index keeps itself up to date — it is never stale.** CodeGraph watches the project and auto-syncs on every file change: while your agent edits code, or you add, modify, or delete files, the graph updates automatically. There is nothing to re-run.
<div align="center">
@@ -359,10 +362,10 @@ Restart your agent (Claude Code / Cursor / Codex CLI / opencode / Hermes Agent /
```bash
cd your-project
codegraph init -i
codegraph init
```
Builds the per-project knowledge graph index. A single global `codegraph install` works in every project you open — no need to re-run the installer per project.
Builds the per-project knowledge graph index, which then auto-syncs on every file change. A single global `codegraph install` works in every project you open — no need to re-run the installer per project.
That's it — your agent will use CodeGraph tools automatically when a `.codegraph/` directory exists.