Skip to main content

Agent/CLI providing eidetic perfect-recall memory

Project description

eidetic-cli

Agent/CLI providing eidetic perfect-recall memory

What you get

  • An agent-first CLI cited from teken (afi-cli) — the runtime declares neo4j and pymongo for its Neo4j and Mongo memory backends; consumers stay dependency-free because they call eidetic over a subprocess boundary.
  • A mesh identityculture.yaml (suffix + backend) and the matching prompt file (CLAUDE.md for backend: claude).
  • The canonical guildmaster skill kit under .claude/skills/, vendored cite-don't-import, plus eidetic's own first-party remember / recall skills (a shared ~/.eidetic/memory store both Claude and the colleague backend can drive). See docs/skill-sources.md.
  • A build + deploy baseline — pytest, lint, the agent-first rubric gate, and PyPI Trusted Publishing wired into GitHub Actions.

Quickstart

uv sync
uv run pytest -n auto               # run the test suite
uv run eidetic whoami              # identity from culture.yaml (console script is `eidetic`, not `eidetic-cli`)
uv run eidetic learn               # self-teaching prompt (add --json)
uv run teken cli doctor . --strict  # the agent-first rubric gate CI runs

CLI

Verb What it does
whoami Report this agent's nick, version, backend, and model from culture.yaml.
learn Print a structured self-teaching prompt.
explain <path> Markdown docs for any noun/verb path.
overview Read-only descriptive snapshot of the agent.
doctor Check the agent-identity invariants (prompt-file-present, backend-consistency).
remember Ingest memory records — one JSON object or NDJSON on stdin; idempotent upsert by id; --backend/--scope/--visibility.
recall <query> Search the store — top-k hits with text + full metadata + score; scope-aware (no private→public leak). Four --modes: exact (substring), approximate (vector), keyword (BM25), hybrid (blend, default; --alpha). Plus --top-k/--filter/--backend/--case-sensitive.
cli overview Describe the CLI surface itself.

Every command supports --json. Results go to stdout, errors/diagnostics to stderr (never mixed). Exit codes: 0 success, 1 user error, 2 environment error, 3+ reserved.

Memory stores

The files backend (default) is self-contained — JSONL on disk, no services. For the neo4j / mongo backends, eidetic owns its own stores via docker-compose.yml:

docker compose up -d                # eidetic-neo4j (bolt :7687) + eidetic-mongo (:27018)
eidetic remember --backend mongo   # the CLI's default connection settings already match

eidetic is the memory layer itself — these are eidetic's own stores (their store / Cypher / embedding logic is adapted from data-refinery, not a dependency on its running stack). Embeddings + rerank come from a separate model-gear HTTP endpoint (EIDETIC_EMBED_URL, EIDETIC_EMBED_MODEL — default http://localhost:8002/v1 + Qwen/Qwen3-Embedding-0.6B), with a deterministic local lexical fallback when it is absent. Only approximate/hybrid recall use it; exact/keyword are pure lexical and work fully offline.

Known limitations (tracked follow-ups): --filter is exact string-equality on metadata (time-range filtering is future work); the files backend re-embeds candidates per search (no embedding cache yet); the Neo4j backend fetches nodes and ranks in Python (vector-index pushdown is future work).

Make it your own

  1. Rename the package eidetic/ and the eidetic-cli CLI/dist name throughout pyproject.toml, the package, tests/, sonar-project.properties, and this README.md. The name is hard-coded in ~30 files, so list every occurrence first — see the git grep discovery command in CLAUDE.md, the authoritative rename procedure.
  2. Edit culture.yaml with your suffix and backend.
  3. Rewrite CLAUDE.md for your agent and run /init.
  4. Re-vendor only the skills you need from guildmaster (see docs/skill-sources.md).

See CLAUDE.md for the full conventions (version-bump-every-PR, the cicd PR lane, deploy setup).

License

MIT — see LICENSE.

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

eidetic_cli-0.4.0.tar.gz (164.8 kB view details)

Uploaded Source

Built Distribution

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

eidetic_cli-0.4.0-py3-none-any.whl (37.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: eidetic_cli-0.4.0.tar.gz
  • Upload date:
  • Size: 164.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for eidetic_cli-0.4.0.tar.gz
Algorithm Hash digest
SHA256 d141ef4181ac8e96c40e0568ff533d97ecd25434dfe219b63f258f0c09eea21b
MD5 c052fc6e3a64bb1e235bc05a85ee5395
BLAKE2b-256 e33eee9d989c8d804e7935f4a9fa9bcc5b174f856a59bf97423c89de126292de

See more details on using hashes here.

File details

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

File metadata

  • Download URL: eidetic_cli-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 37.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for eidetic_cli-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b46db340c98edaa5d8cbc07eabdf37294078e9a2fe250d3dfc2105cd032f6418
MD5 8d48bee47a13d9061c6363625163b065
BLAKE2b-256 fcb96004575b95de334e8ef70e7c76f2ba045585c66af521fd3b567186351c8d

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