Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 48 additions & 47 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,53 +32,54 @@ That's it. Claude Code will automatically read and write memories through the MC

## Commands

| Command | Description |
|---|---|
| `cortex init` | Initialize Cortex -- create DB, start daemon, wire Claude Code |
| `cortex status` | Show daemon status, DB size, memory count |
| `cortex doctor` | Diagnose and auto-fix common issues |
| `cortex version` | Show version info |
| `cortex dashboard` | Open dashboard in browser |
| **Memories** | |
| `cortex show [project]` | Display memories for current or specified project |
| `cortex search <query>` | Full-text search across all memories |
| `cortex add [text]` | Add a memory |
| `cortex edit <id>` | Edit memory metadata |
| `cortex delete <id>` | Delete a memory |
| `cortex supersede <id>` | Replace a memory with new content |
| `cortex clear [project]` | Delete all memories (with backup) |
| **Memory Ops** | |
| `cortex memory pin <id>` | Pin a memory so it is never garbage-collected |
| `cortex memory unpin <id>` | Unpin a memory |
| `cortex analytics` | Usage stats and insights |
| `cortex export` | Export memories to JSON |
| `cortex import <file>` | Import memories from JSON |
| `cortex summarize` | Manually trigger session summarizer |
| `cortex review` | Interactive review of stale and pending memories |
| `cortex timeline [project]` | Chronological memory history |
| `cortex link <id>` | Link a memory to another project |
| **Projects** | |
| `cortex projects` | List all projects |
| `cortex project list` | List all projects |
| `cortex project switch <name>` | Set the active project |
| `cortex project rename <id> <name>` | Rename a project |
| `cortex project archive <id>` | Archive a project |
| **Config** | |
| `cortex config show` | Display current configuration |
| `cortex config set <key> <value>` | Set a configuration value |
| `cortex config reset` | Reset configuration to defaults |
| **Sync** | |
| `cortex sync status` | Show sync state |
| `cortex sync setup` | Configure Turso sync credentials |
| `cortex sync now` | Force immediate sync |
| `cortex sync pause` | Pause automatic sync |
| `cortex sync resume` | Resume automatic sync |
| **Templates** | |
| `cortex template list` | Browse available templates |
| `cortex template apply <name>` | Apply template to current project |
| **Maintenance** | |
| `cortex upgrade` | Upgrade to latest version |
| `cortex uninstall` | Remove Cortex completely |
| Command | Description |
| ----------------------------------- | -------------------------------------------------------------- |
| `cortex init` | Initialize Cortex -- create DB, start daemon, wire Claude Code |
| `cortex status` | Show daemon status, DB size, memory count |
| `cortex count` | Show total memory count (supports --json) |
| `cortex doctor` | Diagnose and auto-fix common issues |
| `cortex version` | Show version info |
| `cortex dashboard` | Open dashboard in browser |
| **Memories** | |
| `cortex show [project]` | Display memories for current or specified project |
| `cortex search <query>` | Full-text search across all memories |
| `cortex add [text]` | Add a memory |
| `cortex edit <id>` | Edit memory metadata |
| `cortex delete <id>` | Delete a memory |
| `cortex supersede <id>` | Replace a memory with new content |
| `cortex clear [project]` | Delete all memories (with backup) |
| **Memory Ops** | |
| `cortex memory pin <id>` | Pin a memory so it is never garbage-collected |
| `cortex memory unpin <id>` | Unpin a memory |
| `cortex analytics` | Usage stats and insights |
| `cortex export` | Export memories to JSON |
| `cortex import <file>` | Import memories from JSON |
| `cortex summarize` | Manually trigger session summarizer |
| `cortex review` | Interactive review of stale and pending memories |
| `cortex timeline [project]` | Chronological memory history |
| `cortex link <id>` | Link a memory to another project |
| **Projects** | |
| `cortex projects` | List all projects |
| `cortex project list` | List all projects |
| `cortex project switch <name>` | Set the active project |
| `cortex project rename <id> <name>` | Rename a project |
| `cortex project archive <id>` | Archive a project |
| **Config** | |
| `cortex config show` | Display current configuration |
| `cortex config set <key> <value>` | Set a configuration value |
| `cortex config reset` | Reset configuration to defaults |
| **Sync** | |
| `cortex sync status` | Show sync state |
| `cortex sync setup` | Configure Turso sync credentials |
| `cortex sync now` | Force immediate sync |
| `cortex sync pause` | Pause automatic sync |
| `cortex sync resume` | Resume automatic sync |
| **Templates** | |
| `cortex template list` | Browse available templates |
| `cortex template apply <name>` | Apply template to current project |
| **Maintenance** | |
| `cortex upgrade` | Upgrade to latest version |
| `cortex uninstall` | Remove Cortex completely |

All commands support `--json` for machine-readable output where applicable.

Expand Down
Loading