Install

The main binary is aidememo. It includes the CLI and MCP server.

From Git

cargo install --git https://github.com/taeyun16/aidememo aidememo-cli

The crates.io release path is being prepared. Until the first registry release lands, use the Git or checkout install paths.

Verify the binary:

aidememo --help
aidememo stats

If your shell cannot find the command, add Cargo's bin directory to your path:

export PATH="$HOME/.cargo/bin:$PATH"

From a checkout

git clone https://github.com/taeyun16/aidememo.git
cd aidememo
mise install
cargo build -p aidememo-cli --release
export PATH="$PWD/target/release:$PATH"

For local development, the repo pins tool versions in mise.toml.

mise run changelog-release-check
mise run release-preflight
mise run cargo-package-readiness
mise run public-registry-smoke
mise run public-portability-check
mise run fresh-checkout-smoke
mise run docs-build
mise run ci-lint
mise run ci-test

The same release preflight is available in GitHub Actions as .github/workflows/release-preflight.yml for a runner-backed pre-publish pass. The clean-checkout onboarding path is also available as .github/workflows/fresh-checkout-smoke.yml; it runs manually and on pull requests that change the installer, CLI, core, or the smoke itself.

changelog-release-check is the fast release-note gate. It verifies that CHANGELOG.md has been cut for the current workspace version before the broader release preflight runs docs, registry, and workflow checks. The full release preflight and cargo-package-readiness gate cover Rust publish dry-runs: aidememo-core is verified first, and dependent Rust crates are checked only after that core crate is published at the matching version. scripts/fresh-checkout-smoke.sh copies the checkout to a temporary directory without target or node_modules, builds the CLI, and verifies the deterministic quickstart path. scripts/public-portability-check.py rejects developer-specific macOS, Linux, and Windows home paths from first-party tracked files so public examples and workflows do not silently depend on one machine. public-registry-smoke is a post-release plan by default; after a real registry publish, run it with AIDEMEMO_PUBLIC_REGISTRY_SMOKE_MODE=verify to install the public packages in temporary environments.

The native Python binding release path uses uvx to run the pinned maturin build tool, so mise install is enough to reproduce the local wheel and publish dry-run checks:

mise run python-pack-smoke
mise run python-publish-dry-run

The pure-Python agent package publish dry-runs use the local Python build backend:

mise run agent-sdk-publish-dry-run
mise run hermes-publish-dry-run

Store location

By default, AideMemo uses its configured local store. For examples and scripts, you can pass an explicit store path:

aidememo --store ./memory.sqlite stats
aidememo --store ./memory.sqlite fact add "A first note" --entities Project

Using --store is useful for demos, tests, and per-project memory files.

Agent installation pins the resolved store path into the generated MCP command. For isolated Codex accounts, install the same store into each profile while keeping writer provenance separate:

aidememo --store ./_meta/wiki.sqlite mcp-install --target codex \
  --codex-home "$HOME/.codex-account-a" --actor-id codex:account-a \
  --codex-home "$HOME/.codex-account-b" --actor-id codex:account-b \
  --source-id project:my-app

See Share Memory Across Codex Profiles for the complete handoff and concurrency pattern.

Install into a coding agent

After the CLI and store work, connect the agent using its native surface:

Agent	Install path
Claude Code	bundled plugin, or mcp-install --target claude plus skill install --target claude
Codex	mcp-install --target codex with optional repeated --codex-home profiles
Hermes Agent	skill install --target hermes plus mcp-install --target hermes, or the hermes-aidememo plugin
pi coding agent	skill install --target pi; there is no MCP step
Cursor / OpenClaw / OpenCode	their corresponding mcp-install target, with skills where supported

See Coding Agent Setup for exact commands, profile variables, plugin choices, and verification steps. The CLI can print its live support matrix at any time:

aidememo mcp-install --list-targets
aidememo skill install --list-targets

Recommended first check

Run this in a temporary directory:

STORE="$(mktemp -d)/wiki.sqlite"

aidememo --store "$STORE" fact add \
  "Decision: AideMemo stores typed project memory locally." \
  --type decision \
  --entities AideMemo

aidememo --store "$STORE" search "typed project memory"

You should see the fact you just added.