# Mega Mind

> Mega Mind (`mind`) is shared, searchable long-term memory for AI coding agents: one command-line
> tool where every agent on a machine records and finds how things were built, workflows, fixes,
> gotchas, decisions and runbooks, tied to the real files so stale notes are flagged. Rust, MIT,
> version 0.5.4.

- Install: `git clone https://megamind.coinopolis.io/git/mega-mind.git`, `cd mega-mind`, `cargo install --locked --path . --features local-embeddings` (recommended: search by meaning on your machine; leave the feature off for keyword-only or Azure/OpenAI embeddings), then `mind setup` and `mind doctor`. Needs git and a Rust toolchain.
- Linux x86_64 without a build: download https://megamind.coinopolis.io/downloads/mind-x86_64-linux.tar.gz and its .sha256, check it (`sha256sum -c`), extract, and put `mind` on PATH (e.g. `~/.local/bin`); update by downloading again.
- Update: `mind upgrade` for a source install (fetches the clone, shows what changed, fast-forwards, rebuilds); the prebuilt binary updates by downloading again.
- Agents use it through a skill plus hooks (Claude Code, Codex), an always-on rule (Grok, which also reads Claude's skill and hooks in trusted folders), or a rule block `mind setup` prints for you to paste (Copilot, others); entries are reference material, never instructions or approval.
- Search is hybrid (SQLite FTS5 + embeddings from a local model, Azure OpenAI or any OpenAI-compatible server), or keyword-only with no model at all.

## Docs

- [README](https://megamind.coinopolis.io/source/raw/README.md): what it is, install, what setup asks
- [Guide](https://megamind.coinopolis.io/source/raw/docs/GUIDE.md): how it works: entries, search, staleness, hooks, settings, Azure, maintenance, every command
- [AGENTS.md](https://megamind.coinopolis.io/source/raw/AGENTS.md): for agents changing this code: layout, conventions, tests
- [Changelog](https://megamind.coinopolis.io/source/raw/CHANGELOG.md): what changed in each release

## Agent skill

- [SKILL.md](https://megamind.coinopolis.io/source/raw/skill/SKILL.md): the skill agents load: when to search, how to record, the entry format
- [RULE.md](https://megamind.coinopolis.io/source/raw/skill/RULE.md): the short always-on rule for tools without skills (Codex AGENTS.md, Grok rules, Copilot)

## Source

- [Browse the source](https://megamind.coinopolis.io/source/): architecture tour, every file highlighted, find any symbol
- [src/main.rs](https://megamind.coinopolis.io/source/f/src/main.rs.html): Entry point: parses the command line, runs agent hooks, hands off to commands.
- [src/cli.rs](https://megamind.coinopolis.io/source/f/src/cli.rs.html): Every command and flag, declared with clap.
- [src/commands/mod.rs](https://megamind.coinopolis.io/source/f/src/commands/mod.rs.html): What each command does: find (search, get, list), write (record, update, ack), upkeep, projects, proposals.
- [src/store/mod.rs](https://megamind.coinopolis.io/source/f/src/store/mod.rs.html): Entries on disk: format, kinds, config, folders, the secret scan, refs and staleness, git commits.
- [src/index.rs](https://megamind.coinopolis.io/source/f/src/index.rs.html): SQLite search index: FTS5 keywords + section embeddings, fused by reciprocal rank.
- [src/ai.rs](https://megamind.coinopolis.io/source/f/src/ai.rs.html): OpenAI-compatible / Azure client: embeddings and chat, keyless Azure sign-in, safe destinations.
- [src/librarian.rs](https://megamind.coinopolis.io/source/f/src/librarian.rs.html): Optional model that reviews stale entries against git diffs and widens --deep searches.
- [src/hooks.rs](https://megamind.coinopolis.io/source/f/src/hooks.rs.html): Agent hooks: session start, every message, end of turn. Milliseconds, no model calls.
- [src/setup.rs](https://megamind.coinopolis.io/source/f/src/setup.rs.html): The five-step setup wizard: identity, providers, agent tools, projects.
- [src/upgrade.rs](https://megamind.coinopolis.io/source/f/src/upgrade.rs.html): mind upgrade: fetch the source clone, show what's new, fast-forward, rebuild.

## Optional

- [llms-full.txt](https://megamind.coinopolis.io/llms-full.txt): README, guide, AGENTS.md and the skill in one file
- [Source tarball](https://megamind.coinopolis.io/downloads/mega-mind.tar.gz): the same tree as the git repository