Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .mimocode/plugins/tui-smoke.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @jsxImportSource @opentui/solid */
import { useKeyboard, useTerminalDimensions, type JSX } from "@opentui/solid"
import { RGBA, VignetteEffect } from "@opentui/core"
import type {
Expand Down
42 changes: 34 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<h1 align="center">MiMoCode</h1>
<h1 align="center">MiMoCode (Android & Termux Fork)</h1>

<p align="center">
<img src="assets/readme/mimocode-banner.png" alt="MiMoCode" width="700">
</p>

<p align="center"><strong>An open-source AI coding agent with cross-session memory.</strong></p>
<p align="center"><strong>An open-source AI coding agent with cross-session memory, optimized for Android & Termux.</strong></p>

<p align="center">
<a href="README.zh.md">中文</a> | English
Expand All @@ -16,20 +16,34 @@

---

MiMoCode 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.
This is a specialized fork of **MiMoCode** (an open-source terminal-native AI coding assistant built on [OpenCode](https://github.com/anomalyco/opencode)) tailored specifically for running natively on **Android (aarch64)** inside **Termux**.

MiMo Auto is built in as a free-for-limited-time channel, so you can start with zero configuration. MiMoCode also supports connecting to any mainstream LLM provider API.
### Why this fork?
Upstream release binaries are glibc-linked and cannot run natively on Android's Bionic libc. This fork addresses this by compiling, configuring, and optimizing MiMoCode to run flawlessly from source under Bun directly on your mobile device. It includes compatibility patches for `node-pty`, `bun install`, and Solid JSX pragmas on Android/Termux.

---

## Quick Start

### Termux / Android (aarch64) Installation (Primary)

Simply run the following one-line command inside Termux:

```bash
# One-line install
curl -fsSL https://mimo.xiaomi.com/install | bash
# One-line install for Termux (Android)
curl -fsSL https://raw.githubusercontent.com/LexGridnev/MiMo-Code/HEAD/termux/setup.sh | bash
```

# Or install via npm
npm install -g @mimo-ai/cli
The installer script automatically:
1. Updates system packages and installs build tools (`git`, `python`, `clang`, `make`, `binutils`, `libandroid-spawn`, `ca-certificates`).
2. Installs Bun (via Termux packages or the official installer).
3. Clones this repository and installs dependencies with the copyfile backend.
4. Rebuilds `node-pty` from source to ensure native terminal compatibility with Android's Bionic libc.
5. Installs a global `mimo` wrapper in your PATH (`$PREFIX/bin/mimo`).

Once installed, simply run `mimo` to start the assistant. You can update the installation later by running:
```bash
mimo upgrade
```

The first launch guides you through configuration automatically. Supported options:
Expand All @@ -38,6 +52,18 @@ The first launch guides you through configuration automatically. Supported optio
- **Import from Claude Code** — migrate existing authentication in one step
- **Custom Provider** — add any OpenAI-compatible API in the TUI

### Standard Installation (Other Platforms)

If you are not on Android/Termux, you can install the upstream version:

```bash
# One-line install
curl -fsSL https://mimo.xiaomi.com/install | bash

# Or install via npm
npm install -g @mimo-ai/cli
```

---

## Core Features
Expand Down
42 changes: 34 additions & 8 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<h1 align="center">MiMoCode</h1>
<h1 align="center">MiMoCode (Android & Termux 分支)</h1>

<p align="center">
<img src="assets/readme/mimocode-banner.png" alt="MiMoCode" width="700">
</p>

<p align="center"><strong>开源 AI 编程智能体,拥有跨会话记忆。</strong></p>
<p align="center"><strong>开源 AI 编程智能体,拥有跨会话记忆,专为 Android & Termux 优化。</strong></p>

<p align="center">
中文 | <a href="README.md">English</a>
Expand All @@ -16,20 +16,34 @@

---

MiMoCode 是一个终端原生的 AI 编程助手。它能读写代码、执行命令、管理 Git,通过持久化记忆系统,在多次会话间保持对你项目的深度理解,并自我进化
这是 **MiMoCode**(一个基于 [OpenCode](https://github.com/anomalyco/opencode) 构建的终端原生 AI 编程助手)的一个专属分支,专门针对 **Android (aarch64)** 平台上的 **Termux** 环境进行了全面原生适配和优化

内置 MiMo Auto 限时免费通道——零配置即可开始使用。也支持接入各家主流 LLM 厂商 API。
### 为什么选择这个分支?
上游发布的官方二进制文件是基于 glibc 链接的,无法在 Android 的 Bionic libc 上原生运行。本分支解决了这一限制,通过配置、修补和优化,使 MiMoCode 能够在移动设备的 Bun 环境下直接从源码完美运行。它包含了针对 Android/Termux 的 `node-pty`、`bun install` 以及 Solid JSX pragma 的兼容性补丁。

---

## 快速开始

### Termux / Android (aarch64) 安装(首选)

在 Termux 中直接运行以下一键安装命令:

```bash
# 一键安装
curl -fsSL https://mimo.xiaomi.com/install | bash
# Termux (Android) 一键安装命令
curl -fsSL https://raw.githubusercontent.com/LexGridnev/MiMo-Code/HEAD/termux/setup.sh | bash
```

# 或通过 npm 安装
npm install -g @mimo-ai/cli
该脚本将自动执行以下操作:
1. 更新 Termux 软件包并安装必要的构建依赖(`git`、`python`、`clang`、`make`、`binutils`、`libandroid-spawn`、`ca-certificates`)。
2. 安装 Bun(使用 Termux 的 `pkg` 或官方安装程序)。
3. 克隆本仓库到您的设备,并以 copyfile 后端安装依赖。
4. 从源码重新构建 `node-pty`,以确保与 Android Bionic libc 的原生终端兼容性。
5. 在您的 Termux PATH(`$PREFIX/bin/mimo`)中安装全局 `mimo` 启动脚本。

安装完成后,只需运行 `mimo` 即可启动助手。您可以随时通过以下命令升级您的安装:
```bash
mimo upgrade
```

首次启动自动引导配置。支持:
Expand All @@ -38,6 +52,18 @@ npm install -g @mimo-ai/cli
- **从 Claude Code 导入** — 一键迁移已有认证
- **自定义 Provider** — TUI 内添加任意 OpenAI 兼容 API

### 标准安装(其他平台)

如果您不是在 Android/Termux 环境下,可以安装官方上游版本:

```bash
# 一键安装
curl -fsSL https://mimo.xiaomi.com/install | bash

# 或通过 npm 安装
npm install -g @mimo-ai/cli
```

---

## 核心特性
Expand Down
Loading