UCode: AI-Powered Development Tool
\r\n\r\n\r\n\r\n---\r\n\r\nUCode is a terminal-native AI coding assistant. It can read and write code, run commands, manage Git, and use a persistent memory system to keep a deep understanding of your project across sessions while continuously improving itself.\r\n\r\nMiMo Auto is built in as a free-for-limited-time channel, so you can start with zero configuration. UCode also supports connecting to any mainstream LLM provider API.\r\n\r\n---\r\n\r\n## Quick Start\r\n\r\n```bash\r\n# One-line install (macOS / Linux)\r\ncurl -fsSL https://mimo.xiaomi.com/install | bash\r\n\r\n# One-line install (Windows PowerShell)\r\npowershell -ep Bypass -c \"irm https://mimo.xiaomi.com/install.ps1 | iex\"\r\n\r\n# Or install via npm (all platforms)\r\n# Mirror registries (e.g. cnpm/taobao) may have delayed platform package sync\r\nnpm install -g @ucode/cli --registry https://registry.npmjs.org\r\n\r\n# Run\r\nucode\r\n```\r\n\r\nThe first launch guides you through configuration automatically. Supported options:\r\n- **MiMo Auto (free for a limited time)** — anonymous channel, zero configuration\r\n- **Xiaomi MiMo Platform** — OAuth login\r\n- **Codex (ChatGPT Pro/Plus)** — OpenAI OAuth login\r\n- **Import from Claude Code** — migrate existing authentication in one step\r\n- **Provider list** — connect catalog providers by API key, or OAuth where supported (e.g. xAI/Grok)\r\n- **Custom Provider** — add any OpenAI-compatible API in the TUI\r\n\r\n---\r\n\r\n## Core Features\r\n\r\n- **Multiple Agents** — build (default), plan (read-only analysis), compose (specs-driven orchestration); press `Tab` to switch\r\n- **Persistent Memory** — cross-session project knowledge, checkpoints, and task progress powered by SQLite FTS5\r\n- **Intelligent Context Management** — automatic checkpoints, context reconstruction, and budgeted injection to stay within model limits\r\n- **Task Tracking** — tree-shaped task system integrated with the checkpoint system\r\n- **Subagent System** — parallel subagents with lifecycle tracking, cancellation, and background execution\r\n- **Goal / Stop Condition** — judge model prevents premature stops during autonomous work\r\n- **Compose Mode** — structured workflow for specs-driven development; recommended via the `/compose-next` skill on the build agent\r\n- **Builtin Skills** — 20+ reusable instruction sets (PDF/Office generation, research, design, and more), invoked via `/skill-name` or auto-matched by relevance\r\n- **Workflows** — deterministic multi-agent orchestration scripts, including built-in compose, deep-research, fact-check, and research-experiment pipelines\r\n- **Voice Input** — real-time streaming voice input powered by TenVAD and MiMo ASR\r\n- **Dream & Distill** — extract knowledge into memory (`/dream`) and discover reusable workflows (`/distill`)\r\n\r\nFor detailed documentation, configuration options, and troubleshooting, see the [GitHub repository](https://github.com/XiaomiMiMo/MiMo-Code).\r\n\r\n---\r\n\r\n## License\r\n\r\nSource code is licensed under the [MIT License](https://github.com/XiaomiMiMo/MiMo-Code/blob/main/LICENSE).\r\n\r\nUse of UCode is also subject to the [Use Restrictions](https://github.com/XiaomiMiMo/MiMo-Code/blob/main/USE_RESTRICTIONS.md).\r\nUse of Xiaomi MiMo-hosted services is subject to the [MiMo Terms of Service](https://platform.xiaomimimo.com/docs/terms/user-agreement).\r\nUse of the MiMo name, logo, and trademarks is subject to the MiMo Trademark Policy.\r\n","readmeFilename":"README.md"}