You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-11Lines changed: 38 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
**The architectural intelligence layer for AI coding agents. Structural graph, architecture governance, multi-agent orchestration, vulnerability mapping, runtime analysis -- one CLI, zero API keys.**
6
6
7
-
*94 commands · 26 languages · architecture OS · 100% local*
7
+
*95 commands · 26 languages · architecture OS · 100% local*
@@ -643,6 +644,21 @@ roam describe --agent-prompt # compact ~500-token prompt (append to any c
643
644
roam minimap --update # inject/refresh annotated codebase minimap in CLAUDE.md
644
645
```
645
646
647
+
**Agent not using Roam correctly?** If your agent is ignoring Roam and falling back to grep/read exploration, it likely doesn't have the instructions. Run:
648
+
649
+
```bash
650
+
roam describe --write # writes instructions to your agent's config (CLAUDE.md, AGENTS.md, etc.)
651
+
```
652
+
653
+
If you already have a config file and don't want to overwrite it:
654
+
655
+
```bash
656
+
roam describe --agent-prompt # prints a compact prompt — copy-paste into your existing config
657
+
roam minimap --update # injects an annotated codebase snapshot into CLAUDE.md (won't touch other content)
658
+
```
659
+
660
+
This teaches the agent which Roam command to use for each situation (e.g., `roam preflight` before changes, `roam context` for files to read, `roam diagnose` for debugging).
@@ -1160,10 +1176,13 @@ Roam is **not** a replacement for your linter, LSP, or SonarQube. It fills a dif
1160
1176
|------|-------------|------------------|
1161
1177
| **ctags / cscope** | Symbol index for editors | Roam adds graph metrics, git signals, architecture analysis, and AI-optimized output |
1162
1178
| **LSP (pyright, gopls)** | Real-time type checking | LSP requires a running server and file:line:col queries. Roam is offline, exploratory, and cross-language |
1163
-
| **Sourcegraph** | Code search + AI | Requires hosted deployment. Roam is local-only, MIT-licensed |
-[ ] VS Code extension (CodeLens for callers/callees, inline health indicators)
1389
+
-[ ] File-system watch mode for sub-second incremental re-indexing
1390
+
-[ ] Embedding-based semantic search via local models (Ollama integration)
1391
+
-[ ] Official GitHub Action marketplace listing
1392
+
-[ ] Token budget management (`--max-tokens` flag for context-aware output)
1366
1393
1367
1394
## Contributing
1368
1395
1369
1396
```bash
1370
1397
git clone https://github.com/Cranot/roam-code.git
1371
1398
cd roam-code
1372
1399
pip install -e .
1373
-
pytest tests/ # All 2654 tests must pass
1400
+
pytest tests/ # All 2656 tests must pass
1374
1401
```
1375
1402
1376
1403
Good first contributions: add a [Tier 1 language](src/roam/languages/) (see `go_lang.py` or `php_lang.py` as templates), improve reference resolution, add benchmark repos, extend SARIF converters, add MCP tools.
0 commit comments