Mimir: A head start, literally

Version 0.3.4 · early release, features and file layout may still change (roadmap, changelog)

Mimir is an exam study plugin for AI coding agents: Claude Code, Codex and Antigravity. It teaches you course material in your professor's style and remembers what you know across sessions.

What it does

• Starts from wherever you are. Type "exam tomorrow, help" and attach a photo of a past paper. Mimir starts drilling right away, with no setup.
• Sets the pace from the exam date. Far from the exam, sessions are short teaching episodes (Standard). Close to it, Mimir drills the question types worth the most points per hour (Urgent). It picks the mode and tells you why.
• Follows your professor. Mimir reads the outline, slides and past papers, learns how the professor writes questions, and labels every question with where it came from. Answer keys are checked before you see them.
• Teaches in your language. Your course and exams can be in one language and the explanations in another. You choose both during setup.
• Remembers you. It keeps dated evidence of what you solved alone and with help, and picks up where you left off.
• Keeps your files on your machine. Everything lives in one folder (default ~/learning/). Generated pages work offline, and Mimir sends no telemetry. The course files Mimir reads are sent to your agent's model provider, like any other file your agent reads.

Install

You need Python 3.11 or newer (available as python3) and one of the agents below. For Codex and Antigravity, also install pdftotext (part of poppler: preinstalled on most Linux, brew install poppler on macOS) for the best PDF text; without it Mimir falls back to a simpler built-in reader.

Claude Code

/plugin marketplace add oguzdogmus/mimir
/plugin install mimir@mimir

Codex

codex plugin marketplace add oguzdogmus/mimir
codex plugin add mimir@mimir

Antigravity

Install the plugin, then always launch from your learning folder with the plugin directory added, and grant the permission requests for both directories:

agy plugin install https://github.com/oguzdogmus/mimir
mkdir -p ~/learning && cd ~/learning
agy --add-dir "$(realpath ~/.gemini/config/plugins/mimir)"

From a local clone (any agent): git clone https://github.com/oguzdogmus/mimir.git ~/mimir, then use ~/mimir in place of oguzdogmus/mimir or the GitHub URL above. To try it in Claude Code for one session without installing: claude --plugin-dir ~/mimir.

Quick start

1. Run mimir-setup once to create your learning folder.
2. Drop course files (outline, slides, past papers) into ~/learning/_inbox/ and run mimir-ingest.
3. Run mimir-study and tell it when your exam is.

Each command is a skill. Type it like this:

mimir-setup and mimir-ingest change your files, so they only run when you type the command yourself; asking in plain words ("set me up") does not start them. For every other command you can just say what you want ("quiz me on automata") and the agent picks the skill. Not sure which fits? Run mimir-help.

Commands

Your learning folder

mimir-ingest sorts what you drop in _inbox/ into one folder per course and term:

~/learning/
├── _inbox/                  drop new course files here
├── .state/profile.md        languages and exam dates
└── 2026-Fall/
    └── CS201 Theory/
        ├── INDEX.md         file list and topic map
        ├── outline/  slides/  past-papers/  notes/
        └── .state/          mastery, professor style, forecast, session logs, generated pages

• Supported files: PDF; images (jpg, png, heic, webp, gif, tiff, bmp); text (md, txt, tex); documents (docx, pptx, odt, odp). Anything else is skipped and left in _inbox/.
• Large files cost usage. Mimir reads your documents through your agent, so big slide decks and scanned papers use a good share of your plan's tokens.
• Changing settings. Pick a different folder during setup. Its path is then stored in ~/.config/mimir/root. To change languages or exam dates later, edit .state/profile.md (plain Markdown), or tell mimir-study your new exam date.
• Backups. Everything Mimir knows about you is in this folder. Copy it to back it up.

The layout may change before 1.0. See Roadmap.

Update or uninstall

Restart your agent after updating. Installed copies do not follow edits to a local clone; update or reinstall to pick them up.

Uninstalling leaves your learning folder untouched.

Compatibility

Tested with Claude Code, Codex and Antigravity. Cursor, Grok Build and Muse Code read the same skill format and may work, but are not tested yet.

So far Mimir has only been tested on CachyOS (Arch Linux). It uses only the Python standard library and each system's default file opener, so other Linux distributions and macOS should work. Windows is untested: the skills call python3, which a standard Windows Python install may not provide (it ships py and python), so WSL is the safer choice for now. If something breaks on your system or agent, please open an issue.

Troubleshooting

Antigravity can't read Mimir's files. Launch with --add-dir as shown in Install and accept the permission requests. A skill symlink alone does not grant access to the plugin folder.

Antigravity through another app doesn't show Mimir's skills. If the app doesn't load plugins, link the skills in:

ln -s ~/.gemini/config/plugins/mimir/skills/mimir-* ~/.gemini/config/skills/

If that app doesn't expand slash commands either, run mimir-setup and mimir-ingest in the Antigravity CLI. The other commands work in plain words.

Roadmap

imageMimir roadmap: shipped foundations, next reliability improvements, planned learning experience improvements, and future textbook support and migrations

Priorities come from hands-on testing and may change. There are no promised dates. Until 1.0, expect changes to how sessions run and to the folder layout. What shipped in 0.3.4 is in the changelog.

• Next: trust every session. Answer keys checked on every agent (#23, #2), smoother installs (#3, #4), and live checks on macOS, Windows and WSL (RELEASE.md).
• Planned: make learning feel clearer. Better-looking pages and diagrams, cleaner question and answer formatting in chat (especially the Claude mobile and desktop apps), and a short lesson before the first worked example in Urgent sessions.
• Exploring: bring the whole course. Real textbook support (today ingest files a textbook, but sessions never read it), chapters linked to course topics, and safe migrations when the folder layout changes.

Development

Run the tests from a clone with uv run --with pytest pytest tests -q. The manual cross-platform check before a release is in RELEASE.md. Issues and their labels are described in docs/agents/.

License

Mimir is open source under the Apache License 2.0. You can use, change and share it, including commercially, as long as you keep the LICENSE and NOTICE files and say which files you changed.

Credits

Math sheets use KaTeX (MIT license), vendored in assets/vendor/katex/.

mimir-help is modelled on Matt Pocock's ask-matt router skill.