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 declaresneo4jandpymongofor its Neo4j and Mongo memory backends; consumers stay dependency-free because they calleideticover a subprocess boundary. - A mesh identity —
culture.yaml(suffix+backend) and the matching prompt file (CLAUDE.mdforbackend: claude). - The canonical guildmaster skill kit under
.claude/skills/, vendored cite-don't-import, plus eidetic's own first-partyremember/recallskills (a shared~/.eidetic/memorystore both Claude and the colleague backend can drive). Seedocs/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 snapshot of the agent plus a live Store section covering all stores: per-backend record counts + live/unavailable status (files/mongo/graph), per-scope + lifecycle breakdown, link-connections, and distinct contributors per scope (union of each record's added_by and metadata.author). Narrow with --backend/--scope. A down backend degrades to unavailable via a fast probe (never crashes). |
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; stamps created date; auto-stamps added_by (resolution: --added-by flag > culture.yaml mesh nick > None); accepts supersedes/links; --backend/--scope/--visibility. |
recall <query> |
Search the store — top-k hits with text + full metadata + score + signal; scope-aware (no private→public leak). Four --modes: exact (substring), approximate (vector), keyword (BM25), hybrid (blend, default; --alpha). Lifecycle flags: --include-shadowed, --include-archived (both excluded by default). Plus --top-k/--filter/--backend/--case-sensitive. |
sweep |
Apply lifecycle transitions (shadow/archive) across the whole store — never deletes, only flips lifecycle. Supports --dry-run. |
migrate qq |
One-shot idempotent import of legacy QQ memory (core.md/notes.md, MongoDB, Neo4j) into a private scope. |
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.
Freshness signal
Every record carries temporal state used to compute a freshness signal — a
float in [0, 1] that blends into recall ranking so recently-created and
frequently-recalled records surface ahead of stale ones:
created— ISO-8601 date stamped atremembertime; drives the age-decay factor (1/(1 + days_old * DECAY_RATE)).last_recall+recall_count— updated passively on everyrecallhit; drive an access bonus (capped at +0.5) and a staleness penalty (days_since_recall * DECAY_RATE).links— related-memory references; reserved for a future corroboration term (weight is currently 0.0, the hook is wired).
The signal is computed at recall time and exposed as signal in every hit
alongside score. Records with no temporal data (undated legacy records) pass
through unmodified — the blend is an exact identity for them.
The blend is multiplicative around the neutral midpoint (SIGNAL_BLEND_BETA = 0.25),
so a fully neutral signal is a no-op and only records carrying real temporal data
move in rank. The formula:
access_bonus = min(0.5, recall_count * 0.05)
age_factor = 1 / (1 + days_old * 0.01)
staleness = days_since_last_recall * 0.01
signal = clamp((0.5 - staleness + access_bonus) * age_factor, 0, 1)
blended_score = score * (1 + 0.25 * (signal - 0.5))
Attribution (added_by)
Every record carries an added_by field that identifies the agent or caller that
ingested it. eidetic remember auto-stamps the field when it is absent from the
record JSON, using this resolution order:
--added-by <value>— explicit override on the CLI flag.culture.yamlmesh nick — thesuffixdeclared in the repo'sculture.yaml; this is the normal case when running inside a mesh agent.None— when noculture.yamlis present (e.g. a wheel install or a bare subprocess call without a repo context).
An explicit added_by value already present in the record JSON is always
preserved verbatim — remember never overwrites a caller-supplied attribution.
The field is None for legacy records that pre-date this feature.
eidetic overview (and overview --store --scope <name>) reports distinct
contributors per scope: the union of each record's added_by and any
metadata.author value, deduplicated and sorted.
# Ingest as a named caller:
eidetic remember --added-by my-agent '{"id":"r1","text":"hello","type":"note"}'
# Override the mesh nick for a bulk import:
echo '{"id":"r2","text":"world","type":"note"}' | eidetic remember --added-by importer
# View contributors per scope:
eidetic overview --scope default
Lifecycle (no hard-delete)
eidetic never deletes a record. Records move through a lifecycle state machine:
| State | Meaning |
|---|---|
active |
Default; visible in recall results. |
shadowed |
Superseded within the same scope by a newer record that declares supersedes. Retrieved only with --include-shadowed. |
archived |
Older than ~1 year (created) or signal below threshold (0.25). Retrieved only with --include-archived. |
Transitions are applied by eidetic sweep (the only command that writes lifecycle
changes). --dry-run reports without writing. Records with metadata.protected
set to a truthy value are exempt from all transitions.
Within-scope shadowing only. A supersedes link only shadows its target when
both records share the same scope (name and visibility). Cross-scope links are
ignored, preserving the public/private no-leak invariant.
Ingest with supersedes and links:
# New version of a record shadows the old one (same scope required):
eidetic remember '{"id":"r2","text":"...","type":"note","supersedes":"r1","links":["r3","r4"]}'
Then run eidetic sweep to apply the transition: r1 gets lifecycle=shadowed,
r2 stays active.
Migrate QQ memory
eidetic migrate qq performs a one-shot idempotent import of the legacy QQ
(Claude's personal) memory stack into a private eidetic scope:
- Sources read:
~/.claude/skills/memory/references/core.mdandnotes.md(one record per##section), MongoDBclaude_notescollection, Neo4j entities taggedknowledge_context="claude". - Destination:
--scope qq --visibility privateby default — personal data never leaks into a public recall. - Idempotent: stable per-source ids (
qq-file:<path>#<section-slug>,qq-mongo:<id>,qq-neo4j:<id>) make re-runs safe. - Resilient: a down Mongo or Neo4j is skipped with a warning, not fatal.
eidetic migrate qq --json # migrate from all sources, JSON report
eidetic migrate qq --backend mongo # store into eidetic's mongo backend
eidetic migrate qq --file ~/my.md # restrict to a specific markdown file
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
- Rename the package
eidetic/and theeidetic-cliCLI/dist name throughoutpyproject.toml, the package,tests/,sonar-project.properties, and thisREADME.md. The name is hard-coded in ~30 files, so list every occurrence first — see thegit grepdiscovery command inCLAUDE.md, the authoritative rename procedure. - Edit
culture.yamlwith yoursuffixandbackend. - Rewrite
CLAUDE.mdfor your agent and run/init. - 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file eidetic_cli-0.7.0.tar.gz.
File metadata
- Download URL: eidetic_cli-0.7.0.tar.gz
- Upload date:
- Size: 256.9 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
20b23051c322f44f1381a8cb6bd09a79cffcc93d38f00b9677b11099fa8d54d5
|
|
| MD5 |
681b696674c50ec5ba5c26a8852e431a
|
|
| BLAKE2b-256 |
36d23ee43f63672118c21dcc3e62c2ceddfe0fea7add2d677c54a74c8b22ae0c
|
File details
Details for the file eidetic_cli-0.7.0-py3-none-any.whl.
File metadata
- Download URL: eidetic_cli-0.7.0-py3-none-any.whl
- Upload date:
- Size: 66.8 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
364d472b8d3b0bc4d899524273f529a6d62ed870283d5c997cd2a1cc09319dc6
|
|
| MD5 |
0efc6aca19d1cc33f0fbcf5739f30a6c
|
|
| BLAKE2b-256 |
0f4a5ba55c2a9e7f23fecbaf7373aa849c81f179b6d053e2cf2dac61c5ae9325
|