Installation

Install Mimir on your system. Choose the method that works best for you.

⚠️

Pre-release: Mimir is currently in development. Installation instructions will be finalized for v1.0 release.

Prerequisites

Before installing Mimir, ensure you have:

Node.js 22 or later - Download Node.js
npm, yarn, or pnpm - Comes with Node.js
(Optional) Docker Desktop - For sandboxed code execution
API key for your preferred LLM provider

Verify Prerequisites

# Check Node.js version
node --version  # Should be v22.0.0 or higher
 
# Check npm version
npm --version
 
# Check Docker (optional)
docker --version

Installation Methods

Linux Installation

Automated installer (recommended):

curl -fsSL https://raw.githubusercontent.com/codedir-labs/mimir-code/main/scripts/install.sh | bash

Manual installation via npm:

npm install -g @codedir/mimir-code
mimir --version

Manual binary installation:

# Download latest binary
curl -L https://github.com/codedir-labs/mimir-code/releases/latest/download/mimir-linux-x64 -o mimir
 
# Make executable
chmod +x mimir
 
# Move to PATH
sudo mv mimir /usr/local/bin/
 
# Verify
mimir --version

macOS Installation

Automated installer (recommended):

curl -fsSL https://raw.githubusercontent.com/codedir-labs/mimir-code/main/scripts/install.sh | bash

Manual installation via npm:

npm install -g @codedir/mimir-code
mimir --version

Manual binary installation:

# Download latest binary (Apple Silicon)
curl -L https://github.com/codedir-labs/mimir-code/releases/latest/download/mimir-macos-arm64 -o mimir
 
# Or for Intel Macs
# curl -L https://github.com/codedir-labs/mimir-code/releases/latest/download/mimir-macos-x64 -o mimir
 
# Make executable
chmod +x mimir
 
# Move to PATH
sudo mv mimir /usr/local/bin/
 
# Verify
mimir --version

On first run, you may need to allow the binary in System Preferences → Security & Privacy.

Windows Installation

Automated installer (recommended):

# Run in PowerShell
iwr -useb https://raw.githubusercontent.com/codedir-labs/mimir-code/main/scripts/install.ps1 | iex

Manual installation via npm:

npm install -g @codedir/mimir-code
mimir --version

Manual binary installation:

# Download latest binary
Invoke-WebRequest -Uri "https://github.com/codedir-labs/mimir-code/releases/latest/download/mimir-win-x64.exe" -OutFile "$env:USERPROFILE\.mimir\bin\mimir.exe"
 
# Add to PATH (one-time setup)
$env:Path += ";$env:USERPROFILE\.mimir\bin"
[Environment]::SetEnvironmentVariable("Path", $env:Path, [EnvironmentVariableTarget]::User)
 
# Verify
mimir --version

⚠️

Windows users should use PowerShell or Windows Terminal, not Command Prompt.

npm/yarn/pnpm Installation

Install using your preferred Node.js package manager:

npm:

npm install -g @codedir/mimir-code
mimir --version

yarn:

yarn global add @codedir/mimir-code
mimir --version

pnpm:

pnpm add -g @codedir/mimir-code
mimir --version

💡

Requires Node.js 22 or higher. This method is cross-platform and works on all systems.

Quick Setup

Initialize Mimir

Navigate to your project and initialize:

cd your-project
mimir init

This creates:

.mimir/ directory
config.yml configuration file
mimir.db SQLite database

Configure API Key

Edit .mimir/config.yml or use environment variables:

# Set environment variable
export DEEPSEEK_API_KEY="your-api-key-here"
 
# Or add to .env file
echo "DEEPSEEK_API_KEY=your-api-key-here" >> .env

Start Mimir

mimir

You should see the interactive prompt. Try asking:

“Explain this project structure”
“Add error handling to functions”
“Write tests for the API client”

Platform-Specific Notes

macOS

On first run, you may need to allow the binary in System Preferences → Security & Privacy.

If you encounter “command not found”, add to PATH:

# For bash
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bash_profile
source ~/.bash_profile
 
# For zsh (macOS default)
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

Linux

Most Linux distributions work out of the box. For older systems, you may need to install:

# Ubuntu/Debian
sudo apt-get install -y ca-certificates curl gnupg
 
# Fedora/RHEL
sudo dnf install -y ca-certificates curl

Windows

⚠️

Windows users should use PowerShell or Windows Terminal, not Command Prompt.

Install via PowerShell script (coming soon):

# Run as Administrator
irm https://github.com/codedir-labs/@codedir/mimir-code/releases/latest/download/install.ps1 | iex

Manual installation:

Download mimir-windows.exe
Move to a directory in your PATH (e.g., C:\Program Files\Mimir\)
Add to PATH:
- System Properties → Advanced → Environment Variables
- Add directory to PATH variable

Docker on Windows:

Install Docker Desktop and ensure WSL 2 backend is enabled.

Docker Setup (Optional)

For sandboxed code execution, install Docker:

Download and install Docker Desktop for Mac.

Verify installation:

docker run hello-world

Download and install Docker Desktop for Windows.

Enable WSL 2 integration in Docker Desktop settings.

Verify installation:

docker run hello-world

Ubuntu/Debian

# Install Docker Engine
sudo apt-get update
sudo apt-get install docker.io
 
# Add user to docker group
sudo usermod -aG docker $USER
 
# Restart session, then verify
docker run hello-world

Fedora/RHEL

sudo dnf install docker
sudo systemctl start docker
sudo usermod -aG docker $USER
docker run hello-world

💡

Docker is optional. Mimir works without it, but sandboxing provides additional security.

Updating

npm update -g @codedir/mimir-code

bash yarn global upgrade @codedir/mimir-code

bash pnpm update -g @codedir/mimir-code

Uninstalling

npm uninstall -g @codedir/mimir-code

bash yarn global remove @codedir/mimir-code

bash pnpm remove -g @codedir/mimir-code

# macOS/Linux
sudo rm /usr/local/bin/mimir
 
# Windows
# Delete from Program Files and remove from PATH

To remove all data:

# Remove global config
rm -rf ~/.mimir
 
# Remove project data
rm -rf .mimir

Troubleshooting

Command not found

Solution: Ensure the installation directory is in your PATH.

# Check PATH
echo $PATH
 
# Find where npm installs global packages
npm root -g
 
# Add to PATH if needed
export PATH="$(npm root -g):$PATH"

Permission denied

Solution: On macOS/Linux, you may need to use sudo or fix npm permissions.

# Fix npm permissions (recommended)
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

Docker not working

Solution: Ensure Docker is running and accessible.

# Check Docker status
docker ps
 
# Start Docker daemon (Linux)
sudo systemctl start docker
 
# Or disable Docker in config
# .mimir/config.yml
docker:
  enabled: false

API key not recognized

Solution: Verify environment variable or config file.

# Check environment variable
echo $DEEPSEEK_API_KEY
 
# Verify config
cat .mimir/config.yml | grep apiKey

Next Steps

Configuration - Configure providers and settings
First Project - Build your first project
Keyboard Shortcuts - Learn productivity shortcuts

Getting Help

Installation issues: Check Troubleshooting section
Report bugs: GitHub Issues
Community: GitHub Discussions

Introduction Custom Commands