Skip to content

ProjectErebyx/erebyx-cli

BranchesTags

Repository files navigation

erebyx-cli

Connect any MCP-capable AI to your EREBYX memory substrate. Persistent memory across every AI you use.

License: MIT OR Apache-2.0 Version DCO

Install in 5 lines

cargo install erebyx                  # native CLI binary
export EREBYX_API_KEY="<YOUR_API_KEY>"    # get one at https://app.erebyx.com/keys
erebyx setup                          # auto-detects every MCP-capable AI on your machine
erebyx save "Anchor-based retrieval improves recall by 40%" --category insight
erebyx remember "anchor retrieval"

That's the whole loop: install -> setup -> save -> remember. Memory follows you across every MCP client on this machine.

What it is

erebyx-cli is the native client for the EREBYX memory substrate. It exposes the v0.1.1 cognitive surface as five verbs you can call from any shell, script, or AI harness:

Verb Purpose
restore-identity Wake up — load identity at session start
load-context Resume — load handoff + recent work
save Store a memory worth keeping
remember Find what you know by meaning
wrap-up Create a session handoff at the end

All processing — memory understanding, recall, organization, encryption — lives behind the API — you never need to think about it.

Three integration paths

Claude Code Cursor Raw integration 
cargo install erebyx
erebyx setup
# Detects ~/.claude/settings.json
# Writes MCP server entry
# Restart Claude Code

See the /core setup guide

 
cargo install erebyx
erebyx setup
# Detects .cursor/mcp.json
# Writes MCP server entry
# Restart Cursor

See the /core setup guide

 
cargo install erebyx
erebyx setup
# Walks API key + config

Or call the HTTP API directly: see the /core setup guide

erebyx setup auto-detects: Claude Code, Cursor, Windsurf, Continue, Zed, VS Code / Copilot.

What erebyx setup writes

For every detected client, the setup writer drops an MCP server entry pointing at the local erebyx mcp-serve binary. Example (Claude Code, Cursor, Windsurf):

{
  "mcpServers": {
    "erebyx-os": {
      "command": "/usr/local/bin/erebyx",
      "args": ["mcp-serve"],
      "env": {
        "EREBYX_API_KEY": "<YOUR_API_KEY>",
        "EREBYX_API_URL": "https://core.erebyx.com",
        "EREBYX_INSTANCE_ID": "default"
      }
    }
  }
}

erebyx mcp-serve is a stdio bridge — it reads JSON-RPC on stdin, forwards to the substrate over HTTPS, and writes responses on stdout. Your AI client speaks pure MCP; the binary does no protocol logic of its own.

Configuration

# Required
export EREBYX_API_KEY="<YOUR_API_KEY>"

# Required for tenants registered at v0.1.1+ (Argon2id-default-on).
# Find it in your dashboard recovery panel. At v0.1.1, EREBYX holds a
# server-side master KEK and can decrypt for support/backup/recovery —
# this is NOT zero-knowledge. When per-user zero-knowledge ships in v0.2,
# your passphrase + BIP39 recovery seed become the ONLY keys to your
# memory; losing both will be unrecoverable by design. Keep both safe.
export EREBYX_PASSPHRASE="<YOUR_PASSPHRASE>"

# Optional (defaults shown)
export EREBYX_API_URL="https://core.erebyx.com"
export EREBYX_INSTANCE_ID="default"

Get your API key at app.erebyx.com/keys. The dashboard surfaces the matching EREBYX_PASSPHRASE value at registration; both are required for new tenants.

X-Erebyx-Hint — lifecycle signals for free

Every CLI call surfaces the substrate's lifecycle hints over HTTP. When the substrate sees a natural consolidation boundary, you get a hint back:

erebyx save "..." --json | jq '.hints'
# ["wrap_up_recommended"]

Hint values:

  • wrap_up_recommended — substrate sees a natural consolidation boundary
  • restore_identity_recommended — voice drift detected (v0.2)
  • load_context_recommended — retrieval scores trending low
  • compact_imminent — sustained save volume; consolidate before context fills

Honoring hints is optional. Disable globally with EREBYX_HINTS_DISABLED=1. Full hint protocol at DEV_QUICKSTART.md.

Usage cheat-sheet

Session start

erebyx restore-identity                          # baseline
erebyx restore-identity --limit 5 --detail full  # rich identity load
erebyx load-context --anchors trading,coding     # filter by domain

During a session

erebyx save "Discovered anchor-based retrieval improves recall by 40%" \
  --category insight \
  --title "Anchor Retrieval Improvement" \
  --anchors memory,retrieval \
  --importance 0.9

erebyx remember "anchor retrieval performance" --limit 5
erebyx remember "trading patterns" --anchors trading --time-range last-week
erebyx remember "anchor retrieval" --ids mem_abc123,mem_def456  # query is required, even with --ids

Session end

erebyx wrap-up "Built the erebyx CLI in Rust" \
  --whats-next "Add shell completions" \
  --anchors cli,rust \
  --energy systematic

Health & diagnostics

erebyx health    # server reachability + version
erebyx doctor    # full client config audit

MCP stdio server

erebyx mcp-serve   # invoked by AI clients; reads JSON-RPC on stdin, writes on stdout

You should not need to run this by hand — erebyx setup wires it into each detected client's MCP config. Use it for direct MCP-over-stdio testing if you're building a custom integration.

JSON output (for agents)

erebyx remember "query" --json | jq '.memories[0].content'

Architecture

src/
  main.rs    Clap dispatch + mcp-serve stdio bridge
  cli.rs     Command surface (5 cognitive verbs + setup, doctor, health, mcp-serve)
  client.rs  HTTP client (reqwest) for MCP JSON-RPC
  output.rs  JSON vs pretty formatting
  setup/     MCP config writers (one per AI client)

The CLI calls the MCP HTTP endpoint at ${EREBYX_API_URL}/mcp/ using JSON-RPC. Each command maps to one MCP tool call. Health uses GET /health directly. mcp-serve reads JSON-RPC on stdin and forwards verbatim to the same /mcp/ endpoint, so AI clients can speak MCP stdio while the substrate stays HTTPS-only.

Headers on every request

  • Authorization: Bearer <api_key> — authentication (canonical Bearer form)
  • X-Instance-ID — multi-tenant routing
  • X-Erebyx-Session-Id — stable per-install id (override with EREBYX_SESSION_ID)
  • Content-Type: application/json

How to upgrade

Track releases in CHANGELOG.md. Backward compatibility is a hard guarantee within v0.1.x — every release lists explicit breaking changes (none expected before v0.2).

cargo install erebyx --force

Build from source

git clone https://github.com/ProjectErebyx/erebyx-cli.git
cd erebyx-cli
cargo build --release
# Binary lands at target/release/erebyx

See also

Contributing

Pull requests welcome. DCO sign-off required (git commit -s). See CONTRIBUTING.md.

Security

Vulnerability reports → legal@erebyx.com. See SECURITY.md.

License

Dual-licensed under either MIT or Apache-2.0 at your option. See NOTICE for attribution requirements when used under Apache-2.0.

Built by EREBYX, LLC — https://erebyx.com

About

EREBYX CLI — Rust binary connecting any MCP-capable AI to the EREBYX memory substrate. Engine private, client surface dual-licensed MIT/Apache-2.0 per Lock 12+28+42.

Topics

rust cli memory mcp claude llm ai-memory model-context-protocol

Resources

Readme

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE-2.0
MIT
LICENSE-MIT

Contributing

Contributing

Security policy

Security policy
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages