diff --git a/README.md b/README.md index 1952acb..bd1dff4 100644 --- a/README.md +++ b/README.md @@ -15,19 +15,19 @@

- YC S26 - Discord - The Memory Layer - CI PyPI Downloads - Sponsor + Discord LinkedIn - X + YC S26

Type `/graphify` in your AI coding assistant and it maps your entire project (code, docs, PDFs, images, videos) into a **knowledge graph** you can **query instead of grepping** through files. +- **Code maps for free, fully local.** Code is parsed with tree-sitter AST: deterministic, no LLM, nothing leaves your machine. (Docs, PDFs, images and video use your assistant's model, or a configured API key, for a semantic pass.) +- **Every edge is explained.** Each connection is tagged `EXTRACTED` (explicit in the source) or `INFERRED` (resolved by graphify), so you can tell what was read directly from what was inferred. +- **Not a vector index.** No embeddings, no vector store: a real graph you traverse. Ask a question, trace the path between two things, or explain one concept. +

graphify's interactive graph.html showing the FastAPI codebase as a force-directed knowledge graph with a legend of detected communities

@@ -35,7 +35,14 @@ Type `/graphify` in your AI coding assistant and it maps your entire project (co The FastAPI codebase mapped by graphify. Every node is a concept, colors are detected communities, and the whole thing is clickable in graph.html.

-**Works in:** Claude Code, Codex, OpenCode, Kilo Code, Cursor, Gemini CLI, GitHub Copilot CLI, VS Code Copilot Chat, Aider, Amp, OpenClaw, Factory Droid, Trae, Hermes, Kimi Code, Kiro, Pi, Devin CLI, and Google Antigravity. +**Get started** (30 seconds): + +```bash +uv tool install graphifyy # install the CLI (or: pipx install graphifyy) +graphify install # register the skill with your AI assistant +``` + +Then, in your AI assistant: ``` /graphify . @@ -50,21 +57,7 @@ graphify-out/ └── graph.json the full graph — query it anytime without re-reading your files ``` ---- - -## What it does - -A knowledge graph is not a vector index: it is **deterministic**, **every edge is explained**, and it costs **zero tokens to build**. - -| Capability | What you get | -|---|---| -| **God nodes** | The most-connected concepts, so you see what everything flows through | -| **Communities** | The graph split into subsystems (Leiden), with LLM-free labels | -| **Cross-file links** | `calls` / `imports` / `inherits` / `mixes_in` resolved across ~40 languages via tree-sitter AST | -| **Query, path, explain** | Ask a question, trace the path between two things, or explain one concept, all against `graph.json` | -| **Rationale + doc refs** | `# NOTE:` / `# WHY:` comments and ADR/RFC citations become first-class nodes linked to the code | -| **Beyond code** | Docs, PDFs, images, and video/audio all map into the same graph | -| **Local-first** | AST plus a local embedder build the graph with zero LLM credits; your code never leaves your machine | +**Works in** Claude Code, Cursor, Codex, Gemini CLI, GitHub Copilot, and 15+ more — [pick your platform](#install). --- @@ -99,6 +92,22 @@ Every edge carries a **confidence tag** (`EXTRACTED` = explicit in the source, ` --- +## What it does + +What you get out of the box: + +| Capability | What you get | +|---|---| +| **God nodes** | The most-connected concepts, so you see what everything flows through | +| **Communities** | The graph split into subsystems (Leiden), with LLM-free labels | +| **Cross-file links** | `calls` / `imports` / `inherits` / `mixes_in` resolved across ~40 languages via tree-sitter AST | +| **Query, path, explain** | Ask a question, trace the path between two things, or explain one concept, all against `graph.json` | +| **Rationale + doc refs** | `# NOTE:` / `# WHY:` comments and ADR/RFC citations become first-class nodes linked to the code | +| **Beyond code** | Docs, PDFs, images, and video/audio all map into the same graph | +| **Local-first** | Code is parsed locally with tree-sitter (no LLM, nothing leaves your machine); only the semantic pass over docs/media calls a backend, and only if you configure one | + +--- + ## Benchmarks | Benchmark | Metric | graphify | Field | @@ -757,6 +766,7 @@ graphify label ./my-project --backend=openai --model gpt-4o # force a specific - [How it works](docs/how-it-works.md) — the extraction pipeline, community detection, confidence scoring, benchmarks - [ARCHITECTURE.md](ARCHITECTURE.md) — module breakdown, how to add a language - [Optional integrations](docs/docker-mcp-sqlite.md) — Docker MCP Toolkit + SQLite +- [The Memory Layer](https://safishamsi.gumroad.com/l/qetvlo) — the book on the ideas behind graphify, the architecture end to end --- @@ -828,3 +838,14 @@ See [ARCHITECTURE.md](ARCHITECTURE.md) for module responsibilities and how to ad Star History Chart

+ +--- + +## Community and links + +

+ Discord + X + Sponsor + The Memory Layer +