Getting Started
Download, install, and configure Mioru in under 5 minutes.
Download & Install
Linux
# Debian/Ubuntu
bash install-debian.sh
# Arch Linux
bash install-arch.sh
# Or download the binary directly
chmod +x mira
./mira
Mioru is a single binary (~18 MB). No runtime, no package manager — just download and run.
Windows
Download mira.exe and launch it. No installer required.
macOS
Download the macOS binary. You may need to right-click → Open on first launch (Gatekeeper).
First Run
- Launch Mioru
- Open Settings (gear icon, top right)
- Set your Notes Directory — where your
.mdfiles live (e.g.~/mira-notes/or a Nextcloud folder) - Add an AI Provider — sign in with ChatGPT or add a Claude API key (see AI Providers)
- Done! Create your first note.
Tip: Point your Notes Directory at a cloud-synced folder (Nextcloud, Dropbox, iCloud) to keep your notes available everywhere.
Requirements & Dependencies
Required
| Component | Purpose | How to get it |
|---|---|---|
| Mioru Binary | The app itself | mioru.org |
| AI Provider | Powers AI chat | ChatGPT account (free) or Anthropic API key |
Optional
| Component | Purpose | How to install |
|---|---|---|
| Pandoc | DOCX export | sudo apt install pandoc / brew install pandoc / winget install JohnMacFarlane.Pandoc |
| Chromium or Edge | PDF export | Pre-installed on most systems (Edge built-in on Windows) |
| OpenAI API Key | Voice transcription (Whisper) | platform.openai.com |
| Tavily API Key | Web search in AI chat | tavily.com — 1,000 searches/month free |
Next Steps
- Learn the keyboard shortcuts — essential hotkeys
- Explore AI Chat — how Mira's AI works with your notes
- Master Ctrl+K — the universal launcher