Skip to content

armgit / Ix

Public Imported from GitHub
0

Understand any codebase instantly. System intelligence for codebases, built for humans and AI.

docs: update docs for phase 2 — diff optimization, fallback bounding, JSON cleanup

riley022705cfa203a49f
diff --git a/AGENTS.md b/AGENTS.md
index 65b86da9..43129a45 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -74,6 +74,8 @@ ix decide <title> --rationale <text> --affects <entities> --format json # Recor
- "List all functions in auth.py" → `ix inventory --kind function --path auth.py`
- "List all classes" → `ix inventory --kind class`
- "What are the most critical methods?" → `ix rank --by callers --kind method --top 10`
+- "What changed between rev 5 and 10?" → `ix diff 5 10 --summary`
+- "Show me all changes" → `ix diff 5 10 --full --format json`
### Low-level structural primitives
@@ -115,7 +117,9 @@ ix ingest --github owner/repo --since 2026-01-01 --format json
```
ix decisions --format json
ix history <id> --format json
-ix diff <from> <to> --format json
+ix diff <from> <to> --summary --format json # Fast revision summary
+ix diff <from> <to> --format json # Full diff (default limit 100)
+ix diff <from> <to> --full --format json # All changes, no limit
```
### Planning & decisions
diff --git a/CLAUDE.md b/CLAUDE.md
index 1dc4b4f4..72c81c72 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -64,7 +64,7 @@ Underlying structural commands — useful for debugging or fine-grained inspecti
|---|---|---|
| Design decisions | `ix decisions` | `ix decisions --topic ingestion --limit 10` |
| Entity history | `ix history` | `ix history <entityId>` |
-| Changes between revisions | `ix diff` | `ix diff 1 5 --format json` |
+| Changes between revisions | `ix diff` | `ix diff 1 5 --summary --format json` |
| Detect contradictions | `ix conflicts` | `ix conflicts --format json` |
| Record a decision | `ix decide` | `ix decide "Use CONTAINS" --rationale "Normalize edges"` |
| Record a goal | `ix truth add` | `ix truth add "Support 100k file repos"` |
@@ -109,6 +109,8 @@ ix inventory --kind function --format json
### Best Practices
- Always use `--kind` with `ix search` to get bounded results
- Use `ix inventory` instead of `ix search ""` for listing entities by kind
+- Use `ix diff --summary` for broad revision comparisons (server-side, fast)
+- Use `--full` only when you need every individual change
- Always use `--limit` to cap result sets
- Use `--format json` when chaining results between commands
- Use `--path` or `--language` to restrict text searches