Skip to content
Get packs

Guide · Open source

How to use MiMo-Code: install, run and set up a model

Updated · written with AI from the project's own documentation and checked against our catalogue data

MiMoCode is a terminal-native AI coding assistant from Xiaomi's MiMo project. It can read and write code, run commands, manage Git, and keep project context between sessions with a persistent memory system. This guide shows you how to install it, run it for the first time, connect a model provider, and use its main features.

MiMoCodeXiaomiMiMo/MiMo-Code · ★ 13.7k · MIT

Quick start

  1. 1Install. Run the one-line installer for your operating system.
  2. 2Launch. Run mimo in your terminal to start the assistant.
  3. 3Connect a provider. Pick Xiaomi MiMo Platform, Codex, Claude Code import, a provider from the list, or a Custom Provider, and finish the login or API key setup.
  4. 4Open your project. Change into your project directory and start working with the assistant.
  5. 5Plan before building. Use the plan agent for read-only analysis, then switch to build with Tab to make changes.
  6. 6Check tools. If you add MCP servers, run mimo mcp to confirm they connect.

Install MiMoCode on macOS, Linux or Windows

Run the one-line installer for your system. On macOS or Linux, use the curl command in a terminal. On Windows, open PowerShell and run the second command.

The README lists no separate prerequisites for installation.

  • macOS and Linux: use the curl command shown below
  • Windows: use the PowerShell command shown below
curl -fsSL https://mimo.xiaomi.com/install | bash powershell -ep Bypass -c "irm https://mimo.xiaomi.com/install.ps1 | iex"

Start MiMoCode and connect a model provider

Start the assistant with the mimo command. The first launch guides you through configuration automatically, and you must choose and connect a provider before you can use it.

The README lists these options: Xiaomi MiMo Platform (OAuth login), Codex with ChatGPT Pro/Plus (OpenAI OAuth login), importing authentication from Claude Code, a provider list where you connect with an API key or OAuth where supported, and a Custom Provider for any OpenAI-compatible API.

  • Xiaomi MiMo Platform: OAuth login
  • Codex (ChatGPT Pro/Plus): OpenAI OAuth login
  • Import from Claude Code: migrates existing authentication in one step
  • Provider list: API key, or OAuth where supported (e.g. xAI/Grok)
  • Custom Provider: any OpenAI-compatible API, added in the TUI
mimo

Use the build and plan agents

MiMoCode has two primary agents. Build is the default and has full tool permissions for development. Plan is read-only, so it suits code exploration and designing a solution before you change anything.

Press Tab to switch between them. Build and Plan can switch at any time; other custom or special modes lock once the first message is sent.

  • build: default, full tool permissions for development
  • plan: read-only analysis for code exploration and solution design

Understand persistent memory across sessions

Memory is stored with SQLite FTS5 full-text search. Project knowledge lives in MEMORY.md, and the agent maintains a checkpoint.md session snapshot. Scratch notes go in notes.md and per-task logs in tasks/<id>/progress.md.

Memory is injected automatically when a session resumes, so the agent does not need to relearn project context.

  • MEMORY.md: project knowledge, rules and architecture decisions
  • checkpoint.md: session state snapshots kept by the checkpoint-writer subagent
  • notes.md: temporary notes for agents
  • tasks/<id>/progress.md: per-task logs

Set up web search (optional)

To let the agent search the web, either set MIMOCODE_ENABLE_EXA=1 to enable the built-in websearch and codesearch tools (backed by Exa), or add a search MCP server under mcp in your config. For higher Exa rate limits, set EXA_API_KEY. Run mimo mcp to check that a server connects.

  • Built-in: set MIMOCODE_ENABLE_EXA=1, optionally EXA_API_KEY
  • MCP: add a server under the mcp key; keys can use {env:VAR}
{ "mcp": { "exa": { "type": "remote", "url": "https://mcp.exa.ai/mcp" }, "tavily": { "type": "remote", "url": "https://mcp.tavily.com/mcp/", "headers": { "Authorization": "Bearer {env:TAVILY_API_KEY}" } } } }

Fix common terminal problems

On macOS, MiMoCode does not support the built-in Terminal.app. If the display is misaligned or flickers, use iTerm2 or the VS Code integrated terminal. On WSL, garbled copied text can be fixed by installing xsel.

If the TUI lags over SSH, run the MiMoCode server on the remote host and attach to it from your local terminal through a port forward. If decorative animation causes lag, run /vivid or switch visuals in the ctrl+p command palette.

  • macOS Terminal.app: not supported; use iTerm2 or VS Code terminal
  • WSL copy problems: sudo apt install xsel
  • SSH lag: mimo serve on the remote host, then mimo attach
mimo serve --port 4096 ssh -N -L 4096:127.0.0.1:4096 user@remote-host mimo attach http://127.0.0.1:4096

What people use it for

  • Asking the assistant to read and edit code in a terminal project
  • Running commands and managing Git from the same session
  • Resuming a project later with memory of earlier decisions
  • Designing a change in read-only plan mode before editing files
  • Connecting your own OpenAI-compatible API key for a custom model

Frequently asked questions

How do I install MiMoCode?

On macOS or Linux, run the curl one-line install command from the README. On Windows, run the PowerShell command that downloads install.ps1. Then start it with the mimo command.

Is MiMoCode free?

The source does not state pricing terms. It is published under the MIT licence, which is shown on the project page. Check your chosen model provider for its own costs.

Does MiMoCode work on macOS Terminal?

No. The README says MiMoCode does not support the built-in Terminal.app. Use iTerm2 or the VS Code integrated terminal instead.

Which model providers can I use?

The README says MiMoCode supports connecting to any mainstream LLM provider API. The first launch offers Xiaomi MiMo Platform, Codex, Claude Code import, a provider list, and a Custom Provider for any OpenAI-compatible API.

How do I fix garbled text on WSL?

The README suggests installing xsel with sudo apt install xsel if copied text is garbled on WSL. For Chinese, Japanese or Korean output on Windows, it describes a system-wide UTF-8 setting as a workaround.

How does MiMoCode compare to other coding assistants?

The source does not include a comparison with other tools. It describes itself as terminal-native, so it is aimed at people who want the assistant in the terminal rather than a graphical editor.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

MiMoCode suits developers who work in the terminal and want an assistant that remembers project context and can plan read-only before editing. Skip it if you need a graphical editor-only tool, use the default macOS Terminal, or do not want to set up a model provider on first launch.

Install options & downloads