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 (11 skills) under .claude/skills/, vendored cite-don't-import. 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); --top-k/--filter/--backend.
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, with a deterministic local lexical fallback when it is absent.

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.3.0.tar.gz (149.6 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.3.0-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: eidetic_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 149.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.22 {"installer":{"name":"uv","version":"0.11.22","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.3.0.tar.gz
Algorithm Hash digest
SHA256 4f5b0a0d1eb6bd274fa167fa4dda694e656500b31e4a68585201ef5c4274141b
MD5 c71dcd70df194fefe1fa5bd8f2e5adc9
BLAKE2b-256 a17ef8f57009a5f521a514355e3b1951a32c5e731e0e927d511452a929094051

See more details on using hashes here.

File details

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

File metadata

  • Download URL: eidetic_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 33.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.22 {"installer":{"name":"uv","version":"0.11.22","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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd35ccaa14312322e3696cd3ea8ddb0777bb87825ad6c140d1a774fd2d1db5de
MD5 27fa0a95768c1e9d80caabe94300b167
BLAKE2b-256 7c2ad6fadcbf8c9b987f0f17fb248b3acd72e44efd0f9c36d20ddd062f6a0193

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