Skip to content

Commit a136331

Browse files
committed
feat: add works-with icons, update README for v1.0.0 release
1 parent 495eda6 commit a136331

16 files changed

Lines changed: 145 additions & 32 deletions

README.md

Lines changed: 64 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,44 @@
88
[![Languages](https://img.shields.io/badge/languages-29-teal?style=flat-square)](docs/architecture.md)
99
[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-lightgrey?style=flat-square)]()
1010
[![npm](https://img.shields.io/npm/v/@1337xcode/cortex?style=flat-square&color=red&label=npm)](https://www.npmjs.com/package/@1337xcode/cortex)
11+
[![Docs](https://img.shields.io/badge/docs-1337xcode.github.io%2Fcortex-blue?style=flat-square)](https://1337xcode.github.io/cortex)
1112

1213
One binary. Zero dependencies. 29 languages. 32 MCP tools. Local code intelligence for AI coding agents.
1314

15+
**[Documentation](https://1337xcode.github.io/cortex)** · **[npm](https://www.npmjs.com/package/@1337xcode/cortex)** · **[Issues](https://github.com/1337Xcode/cortex/issues)**
16+
17+
## Works with
18+
19+
<p>
20+
<img src="assets/icons/claude.svg" width="32" height="32" alt="Claude Code" title="Claude Code" />&nbsp;&nbsp;
21+
<img src="assets/icons/cursor-dark.svg" width="32" height="32" alt="Cursor" title="Cursor" />&nbsp;&nbsp;
22+
<img src="assets/icons/copilot-dark.svg" width="32" height="32" alt="GitHub Copilot" title="GitHub Copilot" />&nbsp;&nbsp;
23+
<img src="assets/icons/windsurf-dark.svg" width="32" height="32" alt="Windsurf" title="Windsurf" />&nbsp;&nbsp;
24+
<img src="assets/icons/vscode.svg" width="32" height="32" alt="VS Code" title="VS Code" />&nbsp;&nbsp;
25+
<img src="assets/icons/codex-dark.svg" width="32" height="32" alt="OpenAI Codex" title="OpenAI Codex" />&nbsp;&nbsp;
26+
<img src="assets/icons/cline-dark.svg" width="32" height="32" alt="Cline" title="Cline" />&nbsp;&nbsp;
27+
<img src="assets/icons/kiro.svg" width="32" height="32" alt="Kiro" title="Kiro" />&nbsp;&nbsp;
28+
<img src="assets/icons/jetbrains.svg" width="32" height="32" alt="JetBrains" title="JetBrains" />&nbsp;&nbsp;
29+
<img src="assets/icons/neovim.svg" width="32" height="32" alt="Neovim" title="Neovim" />
30+
</p>
31+
32+
Any MCP-compatible AI agent, IDE, or CLI tool connects out of the box. `cortex install` auto-detects your setup and writes the config.
33+
1434
## Why Cortex
1535

16-
AI agents burn tokens reading files to answer structural questions. An agent asking "what calls processOrder" gets a 200-token graph result instead of burning 20,000 tokens reading files. Cortex indexes your repository into a SQLite call graph and exposes it over the Model Context Protocol. It handles repositories with 100K to 1M+ lines of code without breaking a sweat. Indexes 127 files in 535ms, incremental re-index in 13ms.
36+
An agent asking "what calls processOrder" gets a 200-token graph result instead of burning 20,000 tokens reading files. That's 100x fewer tokens on a single structural question.
1737

18-
## Install
38+
Cortex indexes your repository into a SQLite call graph and exposes it over the Model Context Protocol. 127 files indexed in 535ms. Incremental re-index in 13ms. Handles 100K to 1M+ line repositories.
1939

20-
**npx (recommended)**
40+
## Install
2141

2242
```sh
2343
npx @1337xcode/cortex install
2444
```
2545

46+
<details>
47+
<summary>Other methods</summary>
48+
2649
**Shell script**
2750

2851
```sh
@@ -37,6 +60,8 @@ cargo build --release
3760
cp target/release/cortex ~/.local/bin/
3861
```
3962

63+
</details>
64+
4065
## Quick start
4166

4267
```sh
@@ -45,21 +70,7 @@ cortex install # detect Claude Code / Cursor, write MCP config
4570
cortex serve # start the MCP server
4671
```
4772

48-
Your agent can now query the graph instead of reading raw files.
49-
50-
## What you get
51-
52-
- **29 languages** parsed via tree-sitter (Python, TypeScript, Rust, Go, Java, C#, C++, Ruby, Kotlin, Swift, PHP, Scala, and 17 more)
53-
- **32 MCP tools** exposed over stdio, or 5 in smart-tools mode (the `ask` meta-tool routes internally)
54-
- **Sub-second incremental re-indexing** via native OS file watcher (inotify, FSEvents, ReadDirectoryChangesW)
55-
- **Taint flow analysis, OWASP Top 10 detection, SBOM generation** all running locally, no cloud
56-
- **Cross-session memory** that marks observations stale when linked code changes
57-
- **Multi-repo federation** for querying across repositories with a unified graph
58-
- **Hybrid search** combining FTS5 BM25 with optional local ONNX vector search
59-
- **CI quality gates** with configurable thresholds and exit codes
60-
- **3D interactive graph visualization** exportable to standalone HTML
61-
- **Portable JSON bundle** (cortex.json) for team sharing via git
62-
- **Works offline.** No cloud, no API keys, no Docker, no language runtimes.
73+
Your agent queries the graph instead of reading raw files.
6374

6475
## Demo commands
6576

@@ -76,6 +87,38 @@ cortex modules # Leiden community detection module boun
7687
cortex federate add ../auth-service # query across repos with unified graph
7788
```
7889

90+
## What you get
91+
92+
- **29 languages** parsed via tree-sitter
93+
- **32 MCP tools** exposed over stdio, or 5 in smart mode (the `ask` meta-tool routes internally)
94+
- **Sub-second incremental re-indexing** via native OS file watcher (inotify, FSEvents, ReadDirectoryChangesW)
95+
- **Taint flow analysis, OWASP Top 10 detection, SBOM generation** all running locally, no cloud
96+
- **Cross-session memory** that marks observations stale when linked code changes
97+
- **Multi-repo federation** for querying across repositories with a unified graph
98+
- **Hybrid search** combining FTS5 BM25 with optional local ONNX vector search
99+
- **CI quality gates** with configurable thresholds and exit codes
100+
- **3D interactive graph visualization** exportable to standalone HTML
101+
- **Portable JSON bundle** (cortex.json) for team sharing via git. `cortex bundle export` serializes the full graph as a portable JSON file. Commit it to git so your team skips the index step entirely.
102+
- **Works offline.** No cloud, no API keys, no Docker, no language runtimes.
103+
104+
<details>
105+
<summary>All 29 supported languages</summary>
106+
107+
| Language | Language | Language |
108+
|----------|----------|----------|
109+
| Python | TypeScript | JavaScript |
110+
| Rust | Go | Java |
111+
| C | C++ | C# |
112+
| Ruby | PHP | Swift |
113+
| Kotlin | Scala | Lua |
114+
| Zig | Haskell | Elixir |
115+
| Dart | R | Julia |
116+
| OCaml | Bash | HCL/Terraform |
117+
| Perl | Objective-C | SQL |
118+
| YAML | TOML | |
119+
120+
</details>
121+
79122
## Architecture
80123

81124
```mermaid
@@ -105,7 +148,7 @@ graph TD
105148
| Smart tool routing | Yes (ask meta-tool) | No | No | No | No |
106149
| Call graph | Function-level | Full chains | Callers/callees | LSP-precise | Cross-file |
107150
| Hybrid search | FTS5 + sqlite-vec | Graph only | RRF fusion | Keyword | Structural |
108-
| Token reduction | 10-100x | 121x avg | Not measured | Not measured | 87% |
151+
| Token reduction | 100x on structural queries | 121x avg | Not measured | Not measured | 87% |
109152
| Incremental update | 13ms (no changes) | Milliseconds | Git hooks | LSP live | Hash-based |
110153
| Security (taint/OWASP/SBOM) | Yes | No | No | No | No |
111154
| Cross-session memory | Staleness-aware | No | No | No | No |
@@ -117,7 +160,7 @@ graph TD
117160
| Coverage gap analysis | Yes (LCOV cross-ref) | No | No | No | No |
118161
| CI quality gates | Yes (exit codes) | No | No | No | No |
119162
| Single binary, zero deps | Yes | Yes | No (Python) | No (Python+LSP) | No (Python) |
120-
| Auto IDE config | 2+ agents | No | No | No | No |
163+
| Auto IDE config | 7 agents | No | No | No | No |
121164
| 3D visualization | Yes | Yes | No | No | No |
122165
| Air-gap compatible | Yes | Yes | Yes | Yes | Yes |
123166
| License | MIT | MIT | MIT | MIT | MIT |
@@ -131,18 +174,7 @@ graph TD
131174
- [Configuration](docs/configuration.md)
132175
- [Architecture](docs/architecture.md)
133176

134-
## Website
135-
136-
The documentation site is built with Astro 5 and deployed to GitHub Pages.
137-
138-
```sh
139-
cd site
140-
npm install
141-
npm run dev # local dev at http://localhost:4321
142-
npm run build # production build to dist/
143-
```
144-
145-
Live at [1337xcode.github.io/cortex](https://1337xcode.github.io/cortex)
177+
Full docs site: [1337xcode.github.io/cortex](https://1337xcode.github.io/cortex)
146178

147179
## License
148180

assets/icons/claude.svg

Lines changed: 1 addition & 0 deletions
Loading

assets/icons/cline-dark.svg

Lines changed: 12 additions & 0 deletions
Loading

assets/icons/cline-light.svg

Lines changed: 5 additions & 0 deletions
Loading

assets/icons/codex-dark.svg

Lines changed: 1 addition & 0 deletions
Loading

assets/icons/codex-light.svg

Lines changed: 1 addition & 0 deletions
Loading

assets/icons/copilot-dark.svg

Lines changed: 1 addition & 0 deletions
Loading

assets/icons/copilot-light.svg

Lines changed: 1 addition & 0 deletions
Loading

assets/icons/cursor-dark.svg

Lines changed: 1 addition & 0 deletions
Loading

assets/icons/cursor-light.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)