Skip to main content

Command-line interface for CortexDB — the long-term memory layer for AI.

Project description

cortexdb-cli

Command-line interface for CortexDB — the long-term memory layer for AI systems.

Wraps the v1 HTTP API in a small, fast Click + Rich CLI. Anonymous signup in one command, no email or card; works against the public SaaS or any self-hosted CortexDB deployment.

Install

pip install cortexdb-cli

Requires Python 3.10+.

Quickstart

# 1. One-time setup — anonymous signup, writes ~/.cortexdb/state.json
cortexdb init

# 2. Store a memory
cortexdb remember "Q3 revenue: $2.4M. We're on track for $10M ARR by year-end."

# 3. Recall it
cortexdb recall "Q3 revenue?"

# 4. Or just type — drops into a REPL
cortexdb

The signup token has a 7-day TTL on the free tier. Re-run cortexdb init to refresh, or pass --api-key + --actor to use a token from your IdP.

Commands

cortexdb init                                 anonymous signup; persist token + actor
cortexdb remember "..."                       store a memory (POST /v1/experience)
cortexdb recall   "..."                       recall a stratified context pack
cortexdb search   "..."                       granular event-level search
cortexdb forget   --memory-id ...             delete with audit
cortexdb episodes {list,get,delete}           episode CRUD
cortexdb entities {list,get,link}             entity rollups over the Facts layer
cortexdb admin    {health,usage,layers}       diagnostics
cortexdb import   data.json                   bulk-load (JSON / JSONL / CSV / TXT)
cortexdb export   -o backup.json              export memories
cortexdb config   {show,set}                  view / edit ~/.cortexdb/config.toml
cortexdb                                      interactive REPL

Configuration

Three layers, in precedence order:

  1. CLI flags--api-key, --endpoint, --actor, --scope, --profile
  2. EnvironmentCORTEXDB_API_KEY, CORTEXDB_URL, CORTEXDB_ACTOR, CORTEXDB_SCOPE
  3. Persisted state:
    • ~/.cortexdb/config.toml — endpoint, profile names (human-editable)
    • ~/.cortexdb/state.json — token, actor, scope, expiry (managed by init, 0600 on POSIX)

The state.json format matches the cortexdb-mcp 0.3.0 server's, so you can copy state across to use both tools from the same anonymous identity.

Pipe-friendly

Auto-detects when stdout isn't a TTY and emits JSON:

cortexdb recall "Q3 revenue" | jq .context_block
cortexdb entities list      | jq '.[].subject'
echo "remember this"        | cortexdb remember -

Force JSON mode any time with --json.

Auth notes

  • The v1 API requires both Authorization: Bearer <PASETO> and X-Cortex-Actor. The CLI stamps both on every request — you never need to pass them by hand.
  • 401s show the specific error code (TOKEN_EXPIRED, actor_mismatch, …) and the remediation: usually cortexdb init.
  • 403s cite the missing capability and the policy tier that denied. If a recall returns diagnostics.read denied, pass --diagnostics none — free-tier tokens don't carry the diagnostics.read capability.

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cortexdb_cli-0.4.0.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cortexdb_cli-0.4.0-py3-none-any.whl (52.4 kB view details)

Uploaded Python 3

File details

Details for the file cortexdb_cli-0.4.0.tar.gz.

File metadata

  • Download URL: cortexdb_cli-0.4.0.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for cortexdb_cli-0.4.0.tar.gz
Algorithm Hash digest
SHA256 e357c89520c49f478677f7b456cfc05600d5eb1b1ab1db2f830c942d7c4725ba
MD5 d9cef7d0180c95b5b979dbfc671cda67
BLAKE2b-256 e66d642959904e1a25bfcc7809ace883d23c918bdafe562e98325cc40a50c8f1

See more details on using hashes here.

File details

Details for the file cortexdb_cli-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: cortexdb_cli-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 52.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for cortexdb_cli-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8d38e4bc716108508c1f85e5f66937be60df6f6411984facd71a0aa30faa3f8c
MD5 131e9390983801c31b1766e10029b969
BLAKE2b-256 ba28680d76859ce87e51ec49177cb06541ea23b51b29f7afa973251932fbab62

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page