mimo-cli 0.1.6 → 0.1.8

package/README.md

@@ -8,78 +8,87 @@
   <a href="https://nodejs.org/">
     <img src="https://img.shields.io/badge/node-%3E%3D18-brightgreen" alt="Node >= 18">
   </a>
+  <a href="https://github.com/ljj6600/MIMO-CLI/releases">
+    <img src="https://img.shields.io/badge/platform-windows-blue" alt="Windows exe">
+  </a>
 </p>
 
 <h1 align="center">MiMo CLI</h1>
-<p align="center"><b>不用写一行代码，帮助你的 Agent 拥有 MiMo 的全部能力。</b></p>
+<p align="center"><b>不用写一行代码，让你的 Agent 拥有 MiMo 的全部能力。</b></p>
 <p align="center">MiMo AI Platform 命令行工具 — 对话、多模态理解、语音识别与合成，一键接入小米大模型。</p>
 
 <p align="center">
   <a href="#安装">安装</a> ·
-  <a href="#快速开始">快速开始</a> ·
+  <a href="#快速上手">快速上手</a> ·
   <a href="#命令参考">命令参考</a> ·
   <a href="#agent-集成">Agent 集成</a> ·
   <a href="#sdk-编程接口">SDK 编程接口</a> ·
   <a href="#默认模型">默认模型</a> ·
-  <a href="#配置">配置</a> ·
-  <a href="#安全">安全</a>
+  <a href="#配置">配置</a>
 </p>
 
 ---
 
-## 安装和配置 CLI
-
-### 通过 Agent 安装
+## 安装
 
-请将以下提示词复制给你的 AI Agent（OpenClaw、Claude Code、Cursor、MaxClaw、AutoClaw、KimiClaw、TRAE、OpenCode 等），它会引导你完成安装、登录与 SKILL 接入（请将 `sk-xxxxx` 替换为你的实际密钥）：
+### 方式一：Windows 独立安装包（推荐，零依赖）
 
-```
-请帮我接入 MiMo CLI（`https://github.com/ljj6600/MIMO-CLI`），按以下三步完成安装与配置：
+无需安装 Node.js，下载即用。
 
-1. 全局安装 CLI：执行 `npm install -g mimo-cli`，完成后用 `mimo --version` 验证
-2. 登录并配置 API Key：执行 `mimo auth login --api-key sk-xxxxx`
-3. 安装官方 SKILL：执行 `npx skills add ljj6600/MIMO-CLI -y -g`
-```
+1. 前往 [Releases 页面](https://github.com/ljj6600/MIMO-CLI/releases) 下载 `mimo-windows-x64.exe`
+2. **双击运行**，自动完成安装并加入系统 PATH
+3. 打开新的 cmd 或 PowerShell，输入 `mimo` 即可使用
 
-### 手动安装
+> 安装路径为 `%LOCALAPPDATA%\mimo\`，不修改系统文件。如需卸载，在终端执行 `mimo uninstall` 即可清除。
 
-#### 1. 安装 MiMo-CLI
-
-在终端运行以下命令完成全局安装：
+### 方式二：npm 全局安装（需 Node.js 18+）
 
 ```bash
 npm install -g mimo-cli
 ```
 
-> 需要 [Node.js](https://nodejs.org/) 18+。
-
-#### 2. 登录 API Key
+> 需要 [Node.js](https://nodejs.org/) 18+ 运行环境。
 
-使用 API Key 完成鉴权（请将 `sk-xxxxx` 替换为你的 Key）：
+### 配置 API Key
 
 ```bash
 mimo auth login --api-key sk-xxxxx
 ```
 
-支持两种 Key 类型，前往 [MiMo 平台](https://platform.xiaomimimo.com) 获取：
-- **TokenPlan Key**（`tp-` 前缀）→ [申请地址](https://platform.xiaomimimo.com/console/plan-manage)，自动配置 `https://token-plan-cn.xiaomimimo.com/v1`
-- **按量计费 Key**（`sk-` 前缀）→ [申请地址](https://platform.xiaomimimo.com/console/api-keys)，自动配置 `https://api.xiaomimimo.com/v1`
+前往 [MiMo 平台](https://platform.xiaomimimo.com) 获取密钥，支持两种类型：
 
-最新版 mimo-cli 会根据 Key 前缀自动检测并配置对应的 Base URL。
+- **TokenPlan Key**（`tp-` 开头）→ [申请地址](https://platform.xiaomimimo.com/console/plan-manage)，自动匹配 `https://token-plan-cn.xiaomimimo.com/v1`
+- **按量计费 Key**（`sk-` 开头）→ [申请地址](https://platform.xiaomimimo.com/console/api-keys)，自动匹配 `https://api.xiaomimimo.com/v1`
 
-#### 3. 安装 SKILL（可选，推荐 Agent 用户）
+CLI 会根据 Key 前缀自动识别类型并配置对应的接口地址，无需手动设置。
 
-若你要在 Claude Code、OpenClaw、Cursor 等 AI Agent 中调用 mimo，建议加装官方 SKILL.md，Agent 调用时决策更准、无需临时翻 `--help`：
+### 安装 SKILL（可选，推荐 Agent 用户）
+
+如果要在 Claude Code、OpenClaw、Cursor 等 AI Agent 中调用 MiMo，建议安装官方 SKILL，让 Agent 的调用更精准：
 
 ```bash
 npx skills add ljj6600/MIMO-CLI -y -g
 ```
 
-SKILL 会自动 symlink 到 `~/.claude/skills/`、`~/.openclaw/skills/` 等目录，各 Agent 下次启动即可识别。仅在终端直接使用 mimo 命令的用户可以跳过此步。
+> 安装后，SKILL 会自动链接到 `~/.claude/skills/`、`~/.openclaw/skills/` 等目录，Agent 重启后即可识别。仅在终端直接使用 `mimo` 命令的用户可以跳过此步。
+
+## 新用户福利
+
+如果你是 **3 天内** 注册 Xiaomi MiMo 开放平台的新用户，可领取专属体验金：
+
+> 🎁 使用邀请码注册，即得 **¥10 API 体验金**（40 天有效）
+
+**三步领取：**
 
-## 快速开始
+1. [点此注册](https://platform.xiaomimimo.com?ref=6MEWY6)
+2. 完成账号注册
+3. 登录控制台，在左下角「邀请码」处输入：`6MEWY6`
 
-### 开箱即用
+体验金适用于 MiMo 全部模型，包括对话、多模态理解、语音识别与合成等。
+
+---
+
+## 快速上手
 
 ```bash
 # 对话
@@ -88,7 +97,7 @@ mimo chat -m "你好，介绍一下你自己"
 # 交互式多轮对话
 mimo repl
 
-# 思维链推理
+# 深度思考
 mimo chat -m "分析一下量子计算的前景" --thinking
 
 # 联网搜索
@@ -97,7 +106,7 @@ mimo chat -m "今天北京天气怎么样" --search
 # 图片理解
 mimo vision --image photo.jpg -p "描述这张图片"
 
-# 视频理解（URL 模式，支持最大 300MB）
+# 视频理解（URL 模式，最大 300MB）
 mimo vision --video https://example.com/video.mp4 -p "描述这个视频"
 
 # 语音识别
@@ -119,37 +128,37 @@ mimo language zh
 
 ## 功能特性
 
-- **对话补全** — 单轮/多轮对话，支持思维链、联网搜索（含地理位置）
+- **对话补全** — 单轮与多轮对话，支持思维链推理与联网搜索（含地理位置）
 - **多模态理解** — 图片、音频、视频内容理解（URL 模式最大 300MB）
 - **语音识别 (ASR)** — wav/mp3 音频转文字，支持流式输出
-- **语音合成 (TTS)** — 预设音色合成 / 声音克隆 / 自定义音色设计
-- **深度思考** — `--thinking` 参数启用推理过程展示
-- **联网搜索** — `--search` 参数，支持位置感知和关键词控制
-- **流式输出** — 实时逐 token 输出，所见即所得
+- **语音合成 (TTS)** — 预设音色、声音克隆、自定义音色设计
+- **深度思考** — `--thinking` 参数展示推理过程
+- **联网搜索** — `--search` 参数，支持位置感知与关键词控制
+- **流式输出** — 逐 token 实时输出，所见即所得
 - **双 Key 管理** — 按量计费与 TokenPlan Key 一键切换
-- **中英文界面** — `mimo language en` 一键切换
-- **安全第一** — API Key 本地加密、输出自动脱敏、路径遍历防护
+- **中英文界面** — 通过 `mimo language en` 自由切换
+- **安全防护** — API Key 仅存本地、输出自动脱敏、路径遍历防护
 
 ## 命令参考
 
 ### `mimo chat`
 
-单轮对话补全，支持深度思考和联网搜索。
+单轮对话，支持深度思考与联网搜索。
 
 ```bash
 mimo chat -m "你好"                                 # 基础对话
 mimo chat -m "分析量子计算" --thinking                # 深度思考
 mimo chat -m "今天天气" --search --user-city 武汉      # 联网搜索
 mimo chat -m "返回 JSON" --json --no-stream           # 结构化输出
-mimo chat -m "写代码" --system "你是 Go 专家"          # 系统提示词
+mimo chat -m "写代码" --system "你是 Go 专家"          # 指定系统提示词
 ```
 
 ### `mimo repl`
 
-交互式多轮对话，维护对话历史。
+交互式多轮对话，自动维护对话上下文。
 
 ```bash
-mimo repl                                           # 启动交互对话
+mimo repl                                           # 启动交互式对话
 mimo repl --thinking --system "你是编程助手"          # 带系统提示词
 mimo repl --search                                  # 联网搜索模式
 ```
@@ -168,7 +177,7 @@ mimo vision --image a.jpg --audio b.mp3 -p "比较两者"         # 多模态组
 
 ### `mimo asr`
 
-语音识别 — 音频转文字。
+语音识别 — 将音频转为文字。
 
 ```bash
 mimo asr recording.wav                                # 基础语音识别
@@ -186,7 +195,7 @@ mimo tts synthesize -t "你好世界"                                 # 基础
 mimo tts synthesize -t "Hello" --voice Mia --format mp3           # 指定音色和格式
 mimo tts synthesize -t "温柔地说" --style "温柔、缓慢" --voice 茉莉 # 风格控制
 mimo tts synthesize -t "文本" --out output.mp3                    # 指定输出路径
-mimo tts voices                                                    # 列出可用音色
+mimo tts voices                                                    # 查看可用音色
 mimo tts clone --sample reference.wav -t "克隆语音"                # 声音克隆
 mimo tts design --prompt "温柔的女声" -t "你好世界"                # 音色设计
 ```
@@ -200,21 +209,22 @@ mimo auth status                   # 查看认证状态
 mimo auth logout                   # 登出
 
 mimo config show                   # 查看当前配置
-mimo config set --key timeout --value 600  # 设置超时
-mimo config set --key active_key --value sk # 切换 Key
+mimo config set --key timeout --value 600        # 设置超时时间
+mimo config set --key active_key --value sk      # 切换使用的 Key
 ```
 
-### `mimo language` · `mimo update`
+### `mimo language` · `mimo update` · `mimo uninstall`
 
 ```bash
 mimo language zh                   # 切换为中文界面
 mimo language en                   # 切换为英文界面
 mimo update                        # 检查并更新到最新版本
+mimo uninstall                     # 卸载 exe 安装版本（仅限 exe 安装方式）
 ```
 
 ## SDK 编程接口
 
-如果你需要将 MiMo 能力集成到自己的 TypeScript/JavaScript 项目中，`mimo-cli` 也提供了完整的编程 SDK。
+`mimo-cli` 也提供了完整的 TypeScript/JavaScript SDK，方便你将 MiMo 能力集成到自己的项目中。
 
 ```typescript
 import { MiMoSDK } from 'mimo-cli/sdk';
@@ -247,7 +257,19 @@ const tts = await sdk.tts.synthesize({
 });
 ```
 
-SDK 与 CLI 共享同一底层 API 客户端，调用方式一致，能力完全对齐。
+SDK 与 CLI 使用同一套底层 API 客户端，调用方式完全一致。
+
+## Agent 集成
+
+如果你想让 AI Agent（如 Claude Code、Cursor 等）直接调用 MiMo 能力，可以将以下提示词交给你的 Agent：
+
+```
+请帮我接入 MiMo CLI（`https://github.com/ljj6600/MIMO-CLI`），按以下三步完成安装与配置：
+
+1. 全局安装 CLI：执行 `npm install -g mimo-cli`，完成后用 `mimo --version` 验证
+2. 登录并配置 API Key：执行 `mimo auth login --api-key sk-xxxxx`
+3. 安装官方 SKILL：执行 `npx skills add ljj6600/MIMO-CLI -y -g`
+```
 
 ## 默认模型
 
@@ -258,11 +280,11 @@ SDK 与 CLI 共享同一底层 API 客户端，调用方式一致，能力完全
 | 语音识别 | `mimo-v2.5-asr` | 语音转文字 |
 | 语音合成 | `mimo-v2.5-tts` | 文字转语音 |
 | 声音克隆 | `mimo-v2.5-tts-voiceclone` | 基于参考音频克隆声音 |
-| 音色设计 | `mimo-v2.5-tts-voicedesign` | 自然语言描述生成音色 |
+| 音色设计 | `mimo-v2.5-tts-voicedesign` | 通过自然语言描述生成音色 |
 
 ## 配置
 
-配置文件位于 `~/.mimo/config.json`：
+配置文件路径：`~/.mimo/config.json`
 
 ```json
 {
@@ -275,14 +297,14 @@ SDK 与 CLI 共享同一底层 API 客户端，调用方式一致，能力完全
 }
 ```
 
-**配置优先级**：命令行标志 > 环境变量 > 配置文件 > 内置默认值
+**优先级顺序**：命令行参数 > 环境变量 > 配置文件 > 内置默认值
 
 ### 环境变量
 
 | 变量 | 说明 |
 |------|------|
 | `MIMO_API_KEY` | API 密钥 |
-| `MIMO_BASE_URL` | API 基础 URL |
+| `MIMO_BASE_URL` | API 接口地址 |
 | `MIMO_CONFIG_DIR` | 配置目录（默认 `~/.mimo`） |
 | `MIMO_OUTPUT` | 输出格式 (text/json) |
 | `MIMO_TIMEOUT` | 请求超时秒数 |
@@ -291,9 +313,9 @@ SDK 与 CLI 共享同一底层 API 客户端，调用方式一致，能力完全
 ## 安全
 
 - API Key 仅存储在本地 `~/.mimo/config.json`，权限 0o600
-- 所有输出自动脱敏，防止 API Key 泄露
+- 输出内容自动脱敏，防止 API Key 意外泄露
 - 文件路径遍历防护
-- 视频文件大小检测（Base64 ≤ 37.5MB / URL ≤ 300MB）
+- 视频文件大小限制检测（Base64 ≤ 37.5MB / URL ≤ 300MB）
 
 ## 开发
 
@@ -301,12 +323,15 @@ SDK 与 CLI 共享同一底层 API 客户端，调用方式一致，能力完全
 # 安装依赖
 bun install
 
-# 开发运行（不构建，直接执行 TypeScript）
+# 开发模式（直接执行 TypeScript，无需构建）
 bun run dev
 
 # 构建（输出到 dist/）
 bun run build
 
+# 构建 Windows 独立可执行文件
+bun run build:exe
+
 # 类型检查
 bun run typecheck
 
@@ -316,12 +341,10 @@ bun run lint
 
 ## 架构
 
-mimo-cli 采用四层架构设计：
-
 ```
 CLI 层 (Commands)         ← 你执行的 mimo xxx 命令
-SDK 层 (编程接口)          ← 你也可以用 TypeScript 调用
-API 客户端层 (Client)      ← OpenAI 兼容协议，一键切换
+SDK 层 (编程接口)          ← 也可以通过 TypeScript 调用
+API 客户端层 (Client)      ← OpenAI 兼容协议，便于切换
 MiMo AI Platform API      ← 小米大模型能力
 ```