Quick Start
Get ekkOS memory working with your AI coding tool in under 2 minutes.
60-Second Dashboard Setup
Minimal effort, maximum lift. Do this immediately after sign-up:
Create Your Account
Sign up and get your API key from the dashboard
Sign Up
Create your account at platform.ekkos.dev — GitHub OAuth or email.
$10 free credits included
Get Your API Key
Go to Settings → API Keys in the dashboard and create a key.
Choose Your Setup Path
Pick the option that works best for you
ekkOS CLI
Two commands. Automatic setup for Claude Code, Cursor, and Windsurf. Includes hooks, context management, and session tracking.
Start hereManual MCP Config
Add the MCP server config to your IDE manually. Good for custom setups or environments where CLI installation isn't possible.
Manual setupCLI Setup
RECOMMENDEDInstall the CLI
One-time global install
npm install -g @ekkos/cli
Initialize
Authenticates your account, detects your IDEs, deploys everything
ekkos init
This will:
- Open your browser for authentication (device code flow)
- Detect installed IDEs (Claude Code, Cursor, Windsurf)
- Deploy MCP server config, hooks, skills, agents, and CLAUDE.md
- Verify everything works
Start coding with memory
Launch Claude Code with ekkOS memory active
ekkos run
Or just type ekkos — it defaults to ekkos run.
ekkOS_Pulse v1.1.9
─────────────────────
Session: cosmic-penguin-runs
Memory: connected (29 tools)
Proxy: active (proxy.ekkos.dev)
Launching Claude Code...
What ekkos run gives you over vanilla Claude Code
Manual MCP Setup
If you prefer manual configuration or can't install the CLI, add the MCP server config directly to your IDE.
Get Your API Key
Sign up at platform.ekkos.dev and generate an API key from Settings
Add MCP Server Config
Choose your IDE below
Claude Code
~/.claude/settings.json{
"mcpServers": {
"ekkos-memory": {
"command": "npx",
"args": ["-y", "@ekkos/mcp-server"],
"env": {
"EKKOS_API_KEY": "your_api_key_here"
}
}
}
}Cursor
.cursor/mcp.json (in project root){
"mcpServers": {
"ekkos-memory": {
"command": "npx",
"args": ["-y", "@ekkos/mcp-server"],
"env": {
"EKKOS_API_KEY": "your_api_key_here"
}
}
}
}Windsurf
.windsurf/mcp.json (in project root){
"mcpServers": {
"ekkos-memory": {
"command": "npx",
"args": ["-y", "@ekkos/mcp-server"],
"env": {
"EKKOS_API_KEY": "your_api_key_here"
}
}
}
}Restart Your IDE
Close and reopen to load the MCP server
You must fully restart your IDE for the MCP configuration to take effect. A window reload is not always sufficient.
Note: Manual MCP setup gives you memory tools (Search, Forge, Directive, etc.) but does not include the API proxy, context eviction, hooks, or session tracking. For those features, use the CLI setup above.
Verify It's Working
Test that ekkOS memory is connected
Ask your AI assistant any of these prompts to confirm memory is active:
"Search my memory for previous solutions""Remember that we use PostgreSQL for the database""What patterns do you know about authentication?"- • AI mentions using ekkOS or memory tools
- • You see tool calls like
ekkOS_Search,ekkOS_Forge, orekkOS_Conflict - • AI recalls information from previous sessions
- • Footer shows session name and turn number (CLI path only)
Optional: Dream Warm Start + Synk Access
GitHub Warm Start (Dream Forge)
Connect GitHub so Dream Forge starts from your real stack and coding style.
- • OAuth callback URL must exactly match:
https://platform.ekkos.dev/api/integrations/github/callback - • Set one complete credential pair:
GITHUB_INTEGRATION_CLIENT_ID/SECRET(or legacyGITHUB_CLIENT_ID/SECRET) - • Optional multi-domain override:
GITHUB_INTEGRATION_BASE_URL
Synk Command Deck Setup
Use Synk for remote session control from dashboard/mobile.
npm i -g @ekkos/remote ekkos-synk auth login ekkos-synk daemon start
Then open /dashboard/synk and pair your browser.
What Can I Do With ekkOS?
ekkOS_Search — Search Memory
Your AI automatically searches its memory before answering technical questions. It recalls past solutions, architecture decisions, and known gotchas.
"How did we handle authentication last time?" "Search memory for database connection patterns" "What do we know about deploying this project?"
ekkOS_Forge — Save Patterns
When your AI solves a non-trivial problem, it automatically saves the solution as a reusable pattern. You can also tell it to remember things explicitly.
"Remember that our API always returns typed responses" "Save this fix as a pattern for future reference" "Never use process.exit() in our codebase"
ekkOS_Directive — Set Rules
Define permanent rules that apply across all sessions. Your AI will follow these rules every time.
"Always use TypeScript strict mode" "Never commit directly to main" "Prefer an ORM over raw SQL"