The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Infimium listing page.
The Private Context Layer & Super Brain for Your Codebase. Give AI agents persistent memory, deep dependency graphs, and instant code context -- 100% local, zero token bloat.
Large repositories make agents read too much code or miss the right symbol. Infimium retrieves compact, relevant context before the agent starts editing.
Requires Node.js 22.5+. From your project folder:
Run setup from the repository you want to index, not from your home directory (~).
Infimium stops broad roots automatically so it cannot scan unrelated files.
That creates global config, starts Ollama if it is installed, pulls nomic-embed-text, indexes the current project or workspace, runs doctor, and opens Playground.
The published CLI keeps its executable entrypoint, so MCP clients can launch it directly through the configuration below.
If Ollama is not installed yet:
infimium setup creates one global config at ~/.infimium/.env. You do not need a .env in every project. Code, docs, memory, graphs, and vectors are stored locally under ~/.infimium/.
Web search is optional. Add a Tinyfish key only when you need it:
Full infimium plan generation also needs a local text model:
infimium plan --dry-run "your task" works without this model and shows the retrieved code context first.
Cursor, Windsurf, Claude Desktop, and other MCP clients:
Restart the client, then use:
Infimium normally uses the MCP process working directory. If your client starts it elsewhere, pass project_path once; Infimium remembers the active project and auto-indexes it.
| Tool | What it does |
|---|---|
hello_infimium | Confirms the MCP server is healthy. |
get_context | Reads saved YAML repo context, current memory and handoff; explicit refresh updates Git/index state. |
infimium_update | Refreshes episodic memory and handoff graphs; controls automatic memory checkpoints. |
semantic_code_search | Finds code by meaning and returns symbol signatures first. |
expand_symbol | Loads one full implementation only when needed. |
query_local_docs | Searches local Markdown, text, HTML, and PDF files. |
dep_graph | Shows imports, callers, callees, and HTTP routes for a symbol. |
project_memory | Keeps active scratchpad events, compact milestones, and durable project rules across agents. |
plan | Builds a grounded implementation plan from code and graph context. |
web_search | Searches the web through optional Tinyfish configuration. |
fetch_url | Extracts readable Markdown or text from a URL. |
shell | Runs allowlisted commands with timeouts and output limits. |
| Command | Description |
|---|---|
infimium doctor | Run health checks on your dependencies and setup. |
infimium status | Show the current status of the index and memory. |
infimium --help | Shows all relevant cli commands. |
infimium playground | Launch the local web UI to explore index, graph, and memory. |
infimium index | Scan and index the current project directory (code, docs, dependencies). |
infimium watch | Run the indexer in watch mode to continuously index changes. |
infimium get-context | Output the full flattened context as YAML (layer.md). |
infimium code-search <query> | Semantically search code and return symbol signatures. |
infimium expand-symbol <symbol> | Fetch the full implementation code for a specific symbol. |
infimium docs-search <query> | Semantically search local markdown/text documentation. |
infimium dep-graph <symbol> | Show dependencies, callers, callees, and route graph. |
infimium plan --dry-run "<task>" | Draft an implementation plan based on a given prompt. |
infimium remember "<note>" | Add a milestone, progress, or decision to project memory. |
infimium resume | Show the active task and recent scratchpad memory events. |
infimium memory complete | Compact the active scratchpad into an archived milestone. |
infimium memory search "<query>" | Semantically search past project rules and memory ledger. |
Use npx infimium ... if you did not install the package globally.
Refresh memory yourself, or enable periodic checkpoints for the current project:
Replace the example notes with your own. Add --project /path/to/repo to select a project and --file src/auth.ts to attach a relevant file. infimium_update and infimium-update are CLI aliases. MCP agents use the infimium_update tool with action: refresh|start|stop|status, project_path, and optional note, task, handoff, files, or interval_seconds.
Auto-update is opt-in and runs while the foreground CLI watcher or an MCP server is open. Its per-project setting survives restarts; stop disables future checkpoints (an in-flight refresh may finish). Checkpoints link episodes, tasks, file references, and handoff notes in local SQLite. Unchanged observations are deduplicated. Automatic checkpoints record observable state, not guessed intent, and never mark a task complete.
get-context / get_context now reads saved context and current memory without rescanning the repo. It includes a bounded memory graph and guidance to answer repo-overview questions only when asked, using Infimium memory first. Missing context is reported explicitly. Run infimium update or get-context --refresh to refresh filesystem context. These are agent guidelines, not an enforcement mechanism for other clients.
Infimium keeps memory bounded across long sessions:
Record meaningful progress while working:
When the task is complete:
Infimium uses the local llama3.1 model when available and falls back to deterministic compaction when it is not. Raw compacted events remain stored locally for seven days before pruning. get_context never calls an LLM or network service.
From a source checkout, build once and run the local playground with:
~/.infimium/grammars/..gitignore, .infimiumignore, and framework defaults exclude dependencies, build output, Flutter artifacts, caches, and binaries before indexing.semantic_code_search returns signatures; expand_symbol provides full code on demand.get_context emits static anchors, dynamic repository state, and active execution as separate YAML zones.Run the normal index command from a folder containing related projects:
Infimium detects immediate project roots from files such as pubspec.yaml, package.json, Cargo.toml, and go.mod. It shows the detected roles and dependencies, asks once, then creates infimium.workspace.json, indexes every project, and opens Playground.
For unattended setup:
Use --no-workspace to index only the current project. Workspace projects keep separate memory and Git state while get_context includes balanced summaries and graph relationships from related projects.
Infimium drops the initial payload cost from approximately 1,460 tokens to 8 tokens per symbol. Semantic search returns the AST signature first; the agent requests the full implementation only when it needs it with expand_symbol.
These are Playground reference values, not a claim that every function has the same size. Inspect your own indexed repository and compare AST-first retrieval with full-text retrieval locally:
Open Token Economics to see the estimated token difference across your actual indexed symbols.
Code, docs, embeddings, memory, graph data, prompts, queries, file paths, and repo names remain local.
Infimium sends privacy-safe anonymous lifecycle telemetry so we can understand setup success:
init_started, init_completeddoctor_run, doctor_passedindex_started, index_completed, setup_completedserve_started, first_tool_call, playground_openedTelemetry includes an anonymous install ID, Infimium version, OS, Node major version, timestamp, and event name. It never includes code, file paths, repo names, prompts, search queries, memory notes, API keys, or user identity.
Disable it anytime:
or set:
Where is layer.md?
When you run infimium get-context, it prints saved context directly to your terminal (stdout). Refreshes store project-scoped YAML under Infimium's local data directory. To export the saved context to a file, use terminal redirection:
Why does the Playground UI say "Awaiting first agent interaction..."?
The CURRENT TASK tracker reflects stored project context. Run infimium update --task "Your task" to refresh it; get-context reads the saved snapshot.
How do I format infimium remember?
The infimium remember command requires a message and a --type flag (valid types: note, progress, decision, blocker, index, plan). If you also want it to update the active task in the Playground, include the --task flag:
If you see Failed to start Infimium: Database is locked, it means another instance of Infimium is actively holding a lock on the SQLite memory database. This usually happens if you try to run infimium index manually in one terminal while infimium playground or infimium watch is still running in another. Simply stop the running process (Ctrl+C) before running manual commands.
Run:
Every failed check prints one copy-paste fix. If setup still fails, give this prompt to your coding agent:
See CONTRIBUTING.md. Adding a language starts with a parser fixture and extraction test.
Self-hosting is free forever under the MIT license.