Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xantorres/engram/llms.txt

Use this file to discover all available pages before exploring further.

Engram is a Python CLI tool that requires Python 3.11 or newer. It is not yet published to PyPI, so all install methods pull directly from the GitHub repository or from a local clone. Once installed, two entry points become available on your PATH: engram for the main CLI and engram-mcp for the standalone MCP server process.
Engram is not yet available on PyPI. Do not run pip install engram or uv add engram — those will either fail or install an unrelated package. Use one of the three methods below.

​
Requirements

RequirementMinimum version
Python3.11
uv (if using uv method)any recent release
pipx (if using pipx method)any recent release
Engram’s runtime dependencies (fastmcp, pydantic, httpx, typer, pyyaml) are installed automatically by all three methods — you do not need to manage them separately.

​
Install Methods

uv tool install git+https://github.com/xantorres/engram
uv is the recommended method. uv tool install creates an isolated virtual environment, resolves dependencies, and links both entry points onto your PATH in a single command. No manual environment activation is needed afterward. pipx follows the same isolated-environment pattern and is a good choice if you already use it to manage other Python CLI tools. Clone and install locally is the right choice if you want to inspect the source, run the test suite, or make local modifications before installing. After cloning, uv tool install . (run from inside the repo directory) installs from the local source tree.
If you plan to modify Engram’s source code regularly, you can instead run uv run engram directly from within the cloned repository without a global install. This keeps your edits active without reinstalling after each change.

​
Verify the Installation

After any of the three install methods, confirm that both entry points are on your PATH: 
engram version
You should see the current version string printed to stdout. If the command is not found, check that your tool bin directory is on PATH:
  • uv tools: typically ~/.local/bin (run uv tool dir --bin to confirm)
  • pipx: typically ~/.local/bin (run pipx ensurepath if needed)

​
Entry Points

Installing Engram registers two executables:
CommandEntry pointPurpose
engramengram.cli.main:mainMain CLI — remember, recall, promote, harvest, and all other subcommands
engram-mcpengram.mcp.server:mainStandalone MCP server process (stdio) used by engram serve and agent config snippets
You will interact with engram directly for all day-to-day operations. The engram-mcp entry point is invoked automatically by your agent harness once you wire it in via engram init — you generally don’t need to call it by hand.

​
Runtime Dependencies

These packages are resolved and installed automatically. They are listed here for reference:
PackageMinimum version
fastmcp2.3
pydantic2.6
httpx0.27
typer0.12
pyyaml6

​
Upgrading

To upgrade to the latest commit from GitHub, re-run the same install command. Both uv tool install and pipx install accept a --force flag to overwrite the existing install: 
uv tool install --force git+https://github.com/xantorres/engram
If you installed from a local clone, pull the latest changes and reinstall: 
git pull
uv tool install --force .

​
Next Steps

With Engram installed and verified, follow the Quickstart to capture your first memories, run the promotion bridge, and wire Engram into your coding agent.

Build docs developers (and LLMs) love

Get started for freeTalk to us