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: docs/getting-started.md
+52-42Lines changed: 52 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: "Getting Started"
3
3
description: "Install Cortex and index your first repository in under a minute."
4
4
order: 1
5
5
category: "guides"
6
-
lastModified: "2025-07-14"
6
+
lastModified: "2026-05-25"
7
7
---
8
8
9
9
# Getting started
@@ -13,10 +13,10 @@ lastModified: "2025-07-14"
13
13
The fastest way to install Cortex:
14
14
15
15
```sh
16
-
npx @1337xcode/cortex install
16
+
npx @1337xcode/cortex@latest install
17
17
```
18
18
19
-
This downloads the binary for your platform, detects your AI coding agents, and writes the MCP config for each one. No manual configuration needed.
19
+
This downloads the binary for your platform, verifies the SHA-256 checksum, removes any stale old versions, configures your PATH, and runs a full index. Zero-touch.
20
20
21
21
Alternatives:
22
22
@@ -30,17 +30,33 @@ cargo build --release
30
30
cp target/release/cortex ~/.local/bin/
31
31
```
32
32
33
+
## Update
34
+
35
+
Cortex checks for updates on every launch and notifies you if a newer version exists. To update:
36
+
37
+
```sh
38
+
cortex update
39
+
```
40
+
41
+
This downloads the latest release, verifies the checksum, replaces the binary, and re-indexes.
42
+
33
43
## Index your repository
34
44
35
45
```sh
36
46
cd /path/to/your/project
37
47
cortex index
38
48
```
39
49
40
-
This parses every source file with tree-sitter, extracts functions, classes, call edges, and import relationships, then stores them in a local SQLite database at `.cortex/graph.db`.
50
+
This parses every source file with tree-sitter (29 languages), extracts functions, classes, call edges, and import relationships, then stores them in a local SQLite database.
41
51
42
52
Indexing is fast. A 3500-file Python project (CPython) indexes in under 60 seconds. A typical 100-file project takes about 500ms.
43
53
54
+
To force a clean rebuild:
55
+
56
+
```sh
57
+
cortex reindex
58
+
```
59
+
44
60
## Start the MCP server
45
61
46
62
```sh
@@ -61,7 +77,7 @@ You don't usually run this manually. The `cortex install` command configures you
61
77
62
78
## Configure your agent
63
79
64
-
If you didn't use `npx @1337xcode/cortex install`, configure manually:
80
+
If you didn't use `npx @1337xcode/cortex@latest install`, configure manually:
65
81
66
82
```sh
67
83
cortex install
@@ -72,57 +88,51 @@ This detects installed agents and writes the correct config for each:
72
88
| Agent | Config location |
73
89
|-------|----------------|
74
90
| Claude Code |~/.claude/settings.json |
75
-
| Claude Desktop (macOS) |~/Library/Application Support/Claude/claude_desktop_config.json |
76
-
| Claude Desktop (Windows) | %APPDATA%\Claude\claude_desktop_config.json |
77
-
| Cursor |~/.cursor/mcp.json |
78
-
| Windsurf |~/.codeium/windsurf/mcp_config.json |
79
-
| VS Code | .vscode/mcp.json (workspace) |
80
-
| Zed |~/.config/zed/settings.json |
81
-
| JetBrains |~/.config/github-copilot/mcp.json |
82
-
| Kiro |~/.kiro/settings/mcp.json |
83
-
| Cline | .cline/mcp.json |
91
+
| Cursor | .cursor/mcp.json |
92
+
| Windsurf | .windsurf/mcp.json |
93
+
| VS Code | .vscode/mcp.json |
94
+
| Kiro | .kiro/settings/mcp.json |
95
+
| Zed | .zed/settings.json |
96
+
| JetBrains | .idea/mcp.json |
97
+
| GitHub Copilot | .github/copilot-mcp.json |
98
+
| Cline/Roo | .vscode/mcp.json |
99
+
100
+
Use `--platform <name>` to configure a specific agent without auto-detection.
84
101
85
102
## Verify it works
86
103
87
104
Ask your agent: "What are the most-called functions in this codebase?"
88
105
89
106
The agent should use the `get_architecture` or `search_symbols` tool and return structural results from the graph rather than reading files.
90
107
91
-
## What happens next
92
-
93
-
Once indexed, Cortex keeps the graph up to date automatically:
94
-
95
-
- The file watcher detects changes and re-indexes modified files in sub-second time
96
-
- Observations you write persist across sessions
97
-
- The bundle (cortex.json) can be committed to git for team sharing
98
-
99
-
## Common next steps
108
+
## Visualize
100
109
101
110
```sh
102
-
# Generate a security report
103
-
cortex security report
104
-
105
-
# See what breaks if you change a function
106
-
cortex impact MyClass.my_method
111
+
# Interactive 3D graph in browser (live server)
112
+
cortex serve
113
+
# Then open http://127.0.0.1:9749
107
114
108
-
# Export an interactive graph visualization
115
+
# Export standalone HTML file
109
116
cortex viz --export graph.html
117
+
```
110
118
111
-
# Set up auto re-indexing on commit
112
-
cortex hook install
113
-
114
-
# Add another repo to the federation
115
-
cortex federate add ../shared-lib
119
+
## Uninstall
116
120
117
-
# Ingest documentation into the graph
118
-
cortex ingest ./docs
121
+
To completely remove Cortex (binary, database, config, PATH entries):
Copy file name to clipboardExpand all lines: npm/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,10 @@ Code intelligence for AI agents. Indexes your repo into a call graph, exposes it
8
8
## Install
9
9
10
10
```sh
11
-
npx @1337xcode/cortex install
11
+
npx @1337xcode/cortex@latest install
12
12
```
13
13
14
-
Downloads the binary for your platform, verifies the SHA256 checksum, drops it in your PATH. Works on Linux, macOS (Intel + Apple Silicon), and Windows.
14
+
Downloads the binary for your platform, verifies the SHA256 checksum, removes any stale cortex binaries from other locations, and drops it in your PATH. Works on Linux, macOS (Intel + Apple Silicon), and Windows. Zero-touch: one command, no manual cleanup needed.
0 commit comments