Skip to content

armgit / Ix

Public Imported from GitHub
0

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

docs: fix README inaccuracies found during end-to-end testing

riley02278227ff65784c
diff --git a/CLAUDE.md b/CLAUDE.md
index d5051404..7642a820 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -49,7 +49,7 @@ Underlying structural commands — useful for debugging or fine-grained inspecti
| Read source code | `ix read` | `ix read src/auth.py:10-50` or `ix read verify_token` |
| Full entity details | `ix entity` | `ix entity <id> --format json` |
| Fast text search | `ix text` | `ix text "verify_token" --language python --limit 20` |
-| Find symbol (graph+text) | `ix locate` | `ix locate AuthProvider --limit 10` |
+| Find symbol (graph+text) | `ix locate` | `ix locate AuthProvider --kind class` |
#### Navigating Relationships
| Goal | Command | Example |
@@ -78,7 +78,7 @@ Underlying structural commands — useful for debugging or fine-grained inspecti
### Ingestion & Health
| Goal | Command | Example |
|---|---|---|
-| Ingest files | `ix ingest` | `ix ingest ./src --recursive` |
+| Ingest files | `ix ingest` | `ix ingest ./src` |
| Ingest GitHub data | `ix ingest` | `ix ingest --github owner/repo --limit 50` |
| Backend health | `ix status` | `ix status` |
| Graph statistics | `ix stats` | `ix stats --format json` |
diff --git a/README.md b/README.md
index 5eb25062..a5cbe6d7 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,7 @@ ix docker start
# 2. Connect a project
cd ~/my-project
ix init
-ix ingest ./src --recursive
+ix ingest ./src
# 3. Use it
ix overview MyService
@@ -70,7 +70,6 @@ ix overview UserService # one-shot summary
ix impact UserService # what depends on it
ix rank --by dependents --kind class --top 10 # most important classes
ix inventory --kind function --path "src/" # list functions
-ix briefing # session resume
```
### Code Navigation
@@ -88,7 +87,9 @@ ix read src/main/scala/ix/memory/Main.scala:1-80
ix text "commitPatch" --language ts --limit 20
```
-### Planning and Tracking
+### Planning and Tracking (Pro)
+
+These commands require [Ix Pro](https://github.com/ix-infrastructure/Ix).
```bash
ix goal create "Support 100k file repos"
@@ -97,6 +98,7 @@ ix plan task "Batch writes" --plan <id>
ix task update <id> --status done
ix decide "Use CONTAINS edge" --rationale "Normalize hierarchy"
ix bug create "Parser fails on decorators" --severity high
+ix briefing # session resume
```
### GitHub Ingestion
@@ -121,7 +123,9 @@ What the hooks do:
## Supported File Types
-`.py`, `.ts`, `.tsx`, `.scala`, `.sc`, `.json`, `.yaml`, `.yml`, `.toml`, `.md`
+**Code** — `.py`, `.ts`, `.tsx`, `.js`, `.jsx`, `.scala`, `.sc`, `.go`, `.java`, `.c`, `.cpp`, `.cs`, `.rb`, `.rs`, `.php`, `.kt`, `.swift`
+
+**Config & Docs** — `.json`, `.yaml`, `.yml`, `.toml`, `.md`
## Uninstall