@yivan-lab/pretty-please 1.3.1 → 1.4.0

package/README.md

@@ -1,187 +1,173 @@
 # Pretty Please (pls)
 
-> 让 AI 把自然语言变成 Shell 命令
+<p align="center">
+  <strong>"Pretty please?" — 用最礼貌的方式，让 AI 帮你干活</strong>
+</p>
 
-一个 AI 驱动的命令行工具，用自然语言描述你想做什么，AI 帮你生成并执行对应的 Shell 命令。
+> `please 查看当前目录` — 就像在跟电脑说话一样自然
 
-## ✨ 特性
+<p align="center">
+  <img src="https://github.com/user-attachments/assets/e06a562c-f899-41d2-8870-d38ebc249904" alt="Pretty Please Demo" width="800">
+</p>
 
-- 🤖 **自然语言转命令** - 用人话说你想干什么，AI 自动生成命令
-- 🔄 **多步骤命令** - AI 自动规划多个步骤，后续命令依赖前面的执行结果
-- 🛡️ **智能错误恢复** - 命令失败时 AI 自动分析并调整策略
-- ✏️ **命令编辑** - 执行前可编辑 AI 生成的命令，支持 manual/auto 两种模式
-- 💬 **AI 对话模式** - 随时问 AI 命令怎么用
-- 🌐 **远程执行** - 通过 SSH 在远程服务器执行命令，支持密码/密钥认证
-- 📜 **三种历史记录** - 命令历史、对话历史、Shell 历史统一管理
-- 🎨 **精美界面** - 基于 React + Ink 的终端 UI，Markdown 渲染
-- 🌗 **主题切换** - 支持 dark/light 主题，适配不同终端背景
-- 🏷️ **命令别名** - 常用操作一键触发，支持参数模板
-- 🔧 **多 Provider 支持** - 支持 OpenAI、DeepSeek、Anthropic 等多种 AI
-- 🚀 **一键升级** - 内置 `pls upgrade` 命令，自动更新到最新版本
+## 这是啥？
 
-## 📦 安装
+忘了 Shell 命令怎么写？没关系，用人话告诉 `pls` 你想干嘛就行。
 
-### 方式一：npm/pnpm 全局安装（推荐）
+**pretty please** 是英语里"拜托了"的意思，而我们的命令就叫 `pls` / `please`，所以每次执行命令都像是在礼貌地请求：
 
 ```bash
-# 使用 npm
-npm install -g @yivan-lab/pretty-please
-
-# 或使用 pnpm
-pnpm add -g @yivan-lab/pretty-please
-
-# 或使用 yarn
-yarn global add @yivan-lab/pretty-please
+please 帮我压缩这个文件夹
+pls 找出占用 8080 端口的进程
+pls 在服务器上重启 nginx
 ```
 
-安装完成后，你可以在任何目录使用 `pls` 或 `please` 命令了！
+AI 生成命令 → 你确认 → 执行 → 搞定。
+
+## ✨ 命令打错了？直接 `pls` 就行
 
-### 方式二：从源码安装
+像 [thefuck](https://github.com/nvbn/thefuck) 一样，命令执行失败后，直接输入 `pls` 让 AI 自动修复：
 
 ```bash
-# 克隆项目
-git clone https://github.com/IvanLark/pretty-please.git
-cd pretty-please
+❯ python --version
+zsh: command not found: python
 
-# 安装依赖
-pnpm install
+❯ pls  # ← 就这么简单！
+✓ 生成命令: python3 --version
+Python 3.9.6
+```
 
-# 构建
-pnpm build
+```bash
+❯ git pus origin main
+git: 'pus' is not a git command. See 'git --help'.
 
-# 全局链接
-pnpm link --global
+❯ pls
+✓ 生成命令: git push origin main
+Enumerating objects: 5, done.
+...
 ```
 
-安装完成后，你可以在任何目录使用 `pls` 或 `please` 命令了！
+不用说"修复上一条命令"，不用重新输入，**直接 `pls`，AI 自动检测失败的命令并生成正确版本**。
+
+## 为什么用这个？
+
+- **命令打错了？** 直接 `pls` 自动修复，像 thefuck 一样方便，但更智能
+- 记不住 `tar` 的一堆参数
+- 想批量处理文件但懒得写脚本
+- 需要在多台服务器上执行同样的操作
+- 想问问某个命令怎么用
 
-### 方式三：一键安装（无需 Node.js）
+## 能干啥？
 
-适用于云服务器、DevOps 场景，无需 Node.js 环境：
+**核心特性：**
+- **自动修复错误** - 命令失败后直接 `pls`，AI 自动检测并生成正确命令（像 thefuck，但更智能）
+- **自然语言转命令** - 生成前让你确认或编辑
+- **智能多步任务** - 复杂任务自动拆分，每步基于上一步的结果
+- **错误恢复重试** - 命令失败了 AI 会分析原因并调整策略
+
+**高级功能：**
+- **远程执行** - 通过 SSH 在服务器上跑命令，支持批量（`-r server1,server2,server3`）
+- **对话模式** - `pls chat grep 怎么用`，随时问问题
+- **命令别名** - 把常用操作存成快捷方式
+- **主题系统** - 7 个内置主题 + 自定义主题
+- **自动升级** - `pls upgrade` 一键更新
+
+## 安装
+
+**方式一：npm（推荐）**
 
-**Linux / macOS:**
 ```bash
-curl -fsSL https://raw.githubusercontent.com/IvanLark/pretty-please/main/install.sh | bash
+npm i -g @yivan-lab/pretty-please
 ```
 
-**Windows (PowerShell):**
-```powershell
+**方式二：一键脚本（无需 Node.js）**
+
+```bash
+# Linux / macOS
+curl -fsSL https://raw.githubusercontent.com/IvanLark/pretty-please/main/install.sh | bash
+
+# Windows PowerShell
 irm https://raw.githubusercontent.com/IvanLark/pretty-please/main/install.ps1 | iex
 ```
 
-支持的平台：
-- Linux x64 / arm64
-- macOS Intel / Apple Silicon
-- Windows x64
-
-## 🚀 快速开始
+支持平台：Linux (x64/arm64) / macOS (Intel/Apple Silicon) / Windows x64
 
-### 1. 配置 API
+## 快速开始
 
-首次使用需要配置 AI API：
+**第一步：配置 API**
 
 ```bash
 pls config
 ```
 
-会启动交互式配置向导，按提示输入：
-- **Provider**: openai / deepseek / anthropic 等（默认 openai）
-- **Base URL**: API 地址
-- **API Key**: 你的 API 密钥
-- **Model**: 模型名称（如 gpt-4-turbo / deepseek-chat）
-- **Shell Hook**: 是否启用Shell Hook（Shell Hook 可以记录你在终端执行的历史命令，让 AI 更智能地理解上下文，推荐启用）
+按提示输入你的 AI API 信息（支持 OpenAI、DeepSeek、Claude 等）
 
-### 2. 开始使用
+**第二步：开始用**
 
 ```bash
-# 生成并执行命令
 pls 查看当前目录
-
-# 复杂任务（多步骤）
-pls 查找大于100MB的日志文件并压缩
-
-# AI 对话模式
-pls chat grep 命令怎么用
+pls 找出大于100MB的文件
+pls chat grep 怎么用
 ```
 
-## 📖 使用示例
+## 使用示例
 
-### 单步命令
+### 基础用法
 
-最基础的用法，用自然语言描述你想做什么：
+最简单的方式，直接说你想干啥：
 
 ```bash
 pls 查看当前目录
 pls 安装 git
-pls 查看当前 IP 地址
+pls 找出占用 8080 端口的进程
 pls 删除所有 .DS_Store 文件
 ```
 
-AI 会生成对应的命令，你确认后执行。
+AI 生成命令，你确认后执行。
 
-### 多步骤命令
+### 多步骤任务
 
-对于需要多个步骤的复杂任务，AI 会自动规划并逐步执行：
+复杂的任务 AI 会自动拆分，每步基于上一步的结果：
 
 ```bash
-pls 查找大于100MB的日志文件并压缩
+pls 找出大于100MB的日志文件并压缩
 ```
 
-执行过程：
-1. **步骤 1**: AI 生成 `find . -name '*.log' -size +100M` 查找大文件
-2. 你确认后执行，找到了 `app.log` 和 `system.log`
-3. **步骤 2**: AI 根据上一步的输出，生成 `tar -czf logs.tar.gz app.log system.log` 压缩命令
-4. 完成！
-
-每步执行后，AI 会根据实际输出结果智能地决定下一步怎么做。
+**执行流程：**
+1. 步骤 1：`find . -name '*.log' -size +100M` 找到了 `app.log` 和 `system.log`
+2. 步骤 2：根据上一步的结果，生成 `tar -czf logs.tar.gz app.log system.log`
+3. 完成！
 
-### 智能引用历史
+### 引用历史
 
-AI 能记住你执行过的命令，支持引用之前的操作：
+AI 记得你之前干了啥：
 
 ```bash
-# 第一步：创建文件
-pls 创建一个名为 test.txt 的文件
+pls 创建一个 test.txt
+pls 删除刚才的文件  # AI 知道你说的是 test.txt
 
-# 第二步：引用刚才的操作
-pls 删除刚才创建的文件
-# AI 会知道你说的是 test.txt
-
-# 或者手动执行了某个命令
+# 或者
 mkdir my-project
 cd my-project
-
-# 然后让 AI 基于当前上下文工作
-pls 在这个目录初始化 git 仓库
+pls 在这个目录初始化 git 仓库  # AI 知道当前上下文
 ```
 
-支持的引用方式：
-- "刚才的文件"
-- "上一个命令"
-- "刚创建的目录"
-- AI 会自动从历史记录中提取相关信息
-
 ### 错误恢复
 
-命令执行失败？AI 会自动分析并调整策略：
+命令失败了 AI 会分析并重试：
 
 ```bash
-pls 将 test.zip 移动到 a、b、c 三个文件夹
+pls 把 test.zip 移动到 a、b、c 三个文件夹
 ```
 
-执行过程：
-1. **步骤 1**: `mv test.zip a/` ✓ 成功
-2. **步骤 2**: `mv test.zip b/` ✗ 失败（文件已被移走）
-3. AI 分析错误，调整策略
-4. **步骤 3**: `cp a/test.zip b/ && cp a/test.zip c/` ✓ 改用复制
+**执行过程：**
+1. `mv test.zip a/` ✓ 成功
+2. `mv test.zip b/` ✗ 失败（文件已被移走）
+3. AI 分析错误，改用复制：`cp a/test.zip b/ && cp a/test.zip c/` ✓ 成功
 
-AI 不会因为一次失败就放弃，而是理解错误原因并找到解决方案。
+### 编辑命令
 
-### 命令编辑
-
-AI 生成的命令可能不完全符合你的需求，你可以在执行前编辑它：
-
-**manual 模式（默认）**：
+生成的命令不满意？按 `E` 编辑：
 
 ```
 ┌─ 生成命令 ───────┐
@@ -190,266 +176,76 @@ AI 生成的命令可能不完全符合你的需求，你可以在执行前编
 
 执行？ [回车执行 / E 编辑 / Esc 取消]
 
-# 按 E 进入编辑
-┌─ 生成命令 ───────┐
-│ ls -la           │  ← AI 建议
-└──────────────────┘
-> ls -l█            ← 可编辑
+# 按 E 后进入编辑
+> ls -l█  ← 可以修改
 
 [回车执行 / Esc 返回]
 ```
 
-**auto 模式**：自动进入编辑，直接修改后执行
+或者用 `auto` 模式，自动进入编辑：
 
 ```bash
-# 切换到 auto 模式
 pls config set editMode auto
 ```
 
-编辑后的命令会被记录到历史中，并标注修改前后的对比。
-
-### 对话模式：命令讲解和问答
+### 对话模式
 
-想了解某个命令怎么用？用 `pls chat` 开启对话模式：
+想问问命令怎么用：
 
 ```bash
-# 询问命令用法
 pls chat tar 命令怎么用
-
-# 解释刚才执行的命令
-pls 找到所有 node_modules 目录并计算大小
-pls chat 刚才那个命令是干嘛的？
-# AI 会详细解释刚才生成的命令的含义和参数
-
-# 提问题
-pls chat 如何批量重命名文件
 pls chat grep 和 awk 有什么区别
-pls chat 如何在 Linux 下挂载硬盘
-
-# 清空对话历史
-pls chat clear
+pls chat 刚才那个命令是干嘛的？  # 会解释你最近执行的命令
 ```
 
-`pls chat` 的特点：
-- 📖 **命令讲解** - 解释命令的含义、参数、用法
-- 💡 **问题解答** - 回答 Shell、Linux、命令行相关问题
-- 🎯 **上下文感知** - 能引用你刚才执行的命令
-- 📝 **Markdown 渲染** - 支持代码高亮、表格、列表等精美格式
-- 💬 **连续对话** - 保留历史，可以追问和深入讨论
+### 远程执行
 
-### 查看历史记录
+在服务器上跑命令：
 
 ```bash
-# 查看命令历史
-pls history
-
-# 查看对话历史
-pls history chat
-
-# 查看 Shell 历史（需要启用 Shell Hook）
-pls history shell
-
-# 清空各种历史
-pls history clear         # 清空命令历史
-pls history chat clear    # 清空对话历史
-pls history shell clear   # 清空 Shell 历史
-```
-
-历史记录包含：
-- 你的原始需求（自然语言）
-- AI 生成的命令
-- 用户修改后的命令（如有修改）
-- 执行状态（成功/失败/退出码）
-- 执行时间
-
-## ⚙️ 配置管理
-
-```bash
-pls config           # 交互式配置向导
-pls config list      # 查看当前配置
-pls config show      # 同上
-pls config set <key> <value>  # 设置单个配置项
-```
-
-### 配置项说明
-
-| 配置项 | 说明 | 默认值 |
-|--------|------|--------|
-| `apiKey` | AI API 密钥 | - |
-| `baseUrl` | API 基础 URL | `https://api.openai.com/v1` |
-| `provider` | AI Provider | `openai` |
-| `model` | 模型名称 | `gpt-4-turbo` |
-| `shellHook` | 启用终端历史记录 | `false` |
-| `editMode` | 命令编辑模式（manual/auto） | `manual` |
-| `chatHistoryLimit` | 对话历史保留轮数 | `10` |
-| `commandHistoryLimit` | 命令历史保留条数 | `10` |
-| `shellHistoryLimit` | Shell 历史保留条数 | `15` |
-| `theme` | 界面主题（dark/light） | `dark` |
-| `aliases` | 命令别名配置 | `{}` |
-
-### 支持的 Provider
-
-- `openai` - OpenAI GPT 系列
-- `deepseek` - DeepSeek
-- `anthropic` - Claude
-- `google` - Gemini
-- `groq` - Groq
-- `mistral` - Mistral AI
-- `cohere` - Cohere
-- `fireworks` - Fireworks AI
-- `together` - Together AI
-
-## 🌐 远程执行
-
-通过 SSH 在远程服务器上执行 AI 生成的命令，支持密码/密钥认证。
-
-### 添加远程服务器
-
-```bash
-# 使用默认密钥（~/.ssh/id_rsa）
+# 添加服务器
 pls remote add myserver root@192.168.1.100
 
-# 指定端口
-pls remote add myserver root@192.168.1.100:2222
-
-# 使用指定密钥
-pls remote add myserver root@192.168.1.100 --key ~/.ssh/my_key
-
-# 使用密码认证（每次执行时输入密码）
-pls remote add myserver root@192.168.1.100 --password
-```
-
-### 管理远程服务器
-
-```bash
-pls remote                    # 查看所有服务器
-pls remote list               # 同上
-pls remote test myserver      # 测试连接并采集系统信息
-pls remote remove myserver    # 删除服务器
-```
-
-### 设置默认服务器
-
-```bash
-pls remote default myserver   # 设置默认服务器
-pls remote default            # 查看当前默认服务器
-pls remote default --clear    # 清除默认服务器
-```
-
-设置默认服务器后，使用 `-r` 参数时可以省略服务器名：
-
-```bash
-pls -r 查看磁盘使用情况        # 使用默认服务器
-```
-
-### 设置工作目录
-
-```bash
-pls remote workdir myserver /var/www    # 设置工作目录
-pls remote workdir myserver             # 查看当前工作目录
-pls remote workdir myserver --clear     # 清除工作目录
-```
-
-设置工作目录后，所有命令会自动在该目录下执行。
-
-### 远程执行命令
-
-```bash
-# 指定服务器执行
+# 远程执行
 pls -r myserver 查看磁盘使用情况
-pls -r myserver 查找大于 100MB 的日志文件
-
-# 使用默认服务器（需先设置）
-pls -r 查看当前目录的文件
-```
-
-### 批量远程执行 ⭐
+pls -r myserver 重启 nginx
 
-在多台服务器上并发执行同一个任务，每个服务器自动生成适配其环境的命令：
-
-```bash
-# 批量执行（逗号分隔服务器名）
+# 批量执行（在多台服务器上同时跑）
 pls -r web1,web2,web3 查看 nginx 状态
-pls -r server1,server2 查看磁盘使用情况
-pls -r prod1,prod2,prod3 重启应用服务
 ```
 
-**特点：**
-- 🚀 **并发执行** - 所有服务器同时生成命令和执行，速度快
-- 🔧 **自动适配** - 每个服务器根据其系统环境生成独立命令（支持异构环境）
-- 📊 **清晰展示** - 显示每个服务器的命令和执行结果
-- 📝 **历史记录** - 自动记录到每个服务器的历史
+### 命令别名
 
-**执行流程示例：**
+把常用操作存成快捷方式：
 
 ```bash
-$ pls -r web1,web2,web3 查看 nginx 状态
-
-正在为 3 台服务器生成命令...
-
-✓ 命令生成完成
-
-web1 (linux):
-  systemctl status nginx | grep Active
-
-web2 (linux):
-  systemctl status nginx | grep Active
-
-web3 (linux):
-  systemctl status nginx | grep Active
-
-将在 3 台服务器执行以上命令
-执行？ [回车执行 / Ctrl+C 取消]
-
-正在执行...
-
-执行完成:
-
-  ✓ web1 (退出码: 0)
-  ✓ web2 (退出码: 0)
-  ✗ web3 (退出码: 3)
-
-─── web1 ───
-   Active: active (running)
+# 添加别名
+pls alias add disk "查看磁盘使用情况，按使用率排序"
 
-─── web2 ───
-   Active: active (running)
+# 使用
+pls disk
 
-─── web3 ───
-   Active: inactive (dead)
+# 带参数的别名
+pls alias add taillog "查看 {{file}} 的最后 {{lines:20}} 行"
+pls taillog --file=/var/log/system.log --lines=50
 ```
 
-**退出码：**
-- `0` - 全部成功
-- `1` - 部分失败
-- `2` - 全部失败
+## 更多功能
 
-**限制：**
-- 批量执行模式不支持多步骤命令（只生成单个命令）
-- 不支持命令编辑（直接执行生成的命令）
-
-### 远程 Shell Hook
-
-在远程服务器上安装 Shell Hook，让 AI 了解你在远程服务器上的操作历史：
+### 历史记录
 
 ```bash
-pls remote hook install myserver    # 安装远程 Hook
-pls remote hook status myserver     # 查看状态
-pls remote hook uninstall myserver  # 卸载 Hook
-```
-
-### 远程历史记录
+pls history              # 命令历史
+pls history chat         # 对话历史
+pls history shell        # Shell 历史（需要启用 Shell Hook）
 
-```bash
-pls remote history show myserver        # 查看远程命令历史
-pls remote history clear myserver       # 清空远程命令历史
-pls remote history shell myserver       # 查看远程 Shell 历史
-pls remote history shell-clear myserver # 清空远程 Shell 历史
+pls history clear        # 清空命令历史
+pls history chat clear   # 清空对话历史
 ```
 
-## 🔧 Shell Hook（可选）
+### Shell Hook
 
-Shell Hook 可以记录你在终端执行的所有命令，让 AI 更智能地理解上下文。
+记录你在终端执行的所有命令，让 AI 更了解上下文：
 
 ```bash
 pls hook install    # 安装 hook
@@ -457,381 +253,187 @@ pls hook status     # 查看状态
 pls hook uninstall  # 卸载 hook
 ```
 
-支持的 Shell：
-- zsh
-- bash
-- PowerShell
+支持 zsh / bash / PowerShell。
 
-## 🌗 主题系统
+### 主题
 
-支持多种内置主题和自定义主题，适配不同终端背景和个人喜好：
-
-### 内置主题
+7 个内置主题 + 自定义主题：
 
 ```bash
 pls theme              # 查看当前主题
-pls theme list         # 查看所有可用主题
-pls theme dark         # 切换到深色主题
-pls theme nord         # 切换到 Nord 主题
-```
-
-**可用的内置主题：**
-- **dark（深色）** - 明亮的颜色，适合深色终端背景（默认）
-- **light（浅色）** - 较深的颜色，适合浅色终端背景
-- **nord（北欧冷色）** - 冷色调护眼主题，适合长时间使用
-- **dracula（德古拉暗色）** - 高对比暗色主题，色彩丰富但不刺眼
-- **retro（复古终端绿）** - 经典终端荧光绿，致敬老派 hacker 风格
-- **contrast（高对比度）** - 极高对比度，适合视力辅助和强光环境
-- **monokai（经典编辑器）** - Monokai 经典配色，开发者熟悉的选择
-
-也可以通过配置命令切换：
-
-```bash
-pls config set theme nord
-```
-
-### 自定义主题
-
-创建你自己的主题配色方案：
-
-#### 1. 创建主题模板
-
-```bash
-# 创建深色主题
-pls theme create my-ocean --display-name "我的海洋主题"
-
-# 创建浅色主题
-pls theme create my-light --display-name "我的浅色" --category light
-```
-
-这会在 `~/.please/themes/` 目录下生成一个 JSON 模板文件。
-
-#### 2. 编辑主题文件
-
-```bash
-vim ~/.please/themes/my-ocean.json
+pls theme list         # 查看所有主题
+pls theme nord         # 切换主题
 ```
 
-主题文件格式：
-
-```json
-{
-  "metadata": {
-    "name": "my-ocean",
-    "displayName": "我的海洋主题",
-    "description": "深邃的海洋蓝配色",
-    "category": "dark",
-    "author": "Your Name"
-  },
-  "colors": {
-    "primary": "#0077BE",
-    "secondary": "#5DADE2",
-    "accent": "#48C9B0",
-    "success": "#2ECC71",
-    "error": "#E74C3C",
-    "warning": "#F39C12",
-    "info": "#3498DB",
-    "text": {
-      "primary": "#ECF0F1",
-      "secondary": "#BDC3C7",
-      "muted": "#95A5A6",
-      "dim": "#7F8C8D"
-    },
-    "border": "#34495E",
-    "divider": "#2C3E50",
-    "code": {
-      "background": "#1C2833",
-      "text": "#ECF0F1",
-      "keyword": "#C678DD",
-      "string": "#98C379",
-      "function": "#61AFEF",
-      "comment": "#5C6370"
-    }
-  }
-}
-```
+**内置主题：** dark、light、nord、dracula、retro、contrast、monokai
 
-#### 3. 验证主题
+**自定义主题：**
 
 ```bash
-pls theme validate ~/.please/themes/my-ocean.json
+pls theme create my-theme --display-name "我的主题"
+vim ~/.please/themes/my-theme.json  # 编辑主题配置
+pls theme validate ~/.please/themes/my-theme.json  # 验证
+pls theme my-theme  # 应用
 ```
 
-验证通过后会显示主题信息，失败会给出详细的错误提示。
+### 远程执行详细说明
 
-#### 4. 应用自定义主题
+**添加服务器：**
 
 ```bash
-pls theme my-ocean
+pls remote add myserver root@192.168.1.100
+pls remote add myserver root@192.168.1.100 --key ~/.ssh/my_key
+pls remote add myserver root@192.168.1.100 --password  # 密码认证
 ```
 
-#### 5. 管理自定义主题
+**管理服务器：**
 
 ```bash
-# 查看所有主题（内置 + 自定义）
-pls theme list
-
-# 只查看自定义主题
-pls theme list --custom
-
-# 只查看内置主题
-pls theme list --builtin
+pls remote                    # 查看所有服务器
+pls remote test myserver      # 测试连接
+pls remote remove myserver    # 删除
+pls remote default myserver   # 设置默认服务器
+pls remote workdir myserver /var/www  # 设置工作目录
 ```
 
-自定义主题在列表中会显示 ✨ 标记。
-
-**主题文件位置：** `~/.please/themes/`
-
-**颜色格式：** 所有颜色必须使用十六进制格式（如 `#00D9FF`）
-
-## 🏷️ 命令别名
-
-将常用的操作保存为别名，一键触发：
-
-### 基本使用
+**远程执行：**
 
 ```bash
-# 添加简单别名
-pls alias add disk "查看磁盘使用情况，按使用率排序"
-pls alias add mem "查看内存使用最高的 10 个进程"
-
-# 使用别名（两种格式都支持）
-pls disk
-pls @disk
-
-# 查看所有别名
-pls alias
-pls alias list
+pls -r myserver 查看磁盘使用情况
+pls -r 查看当前目录  # 使用默认服务器
 
-# 删除别名
-pls alias remove disk
+# 批量执行
+pls -r web1,web2,web3 重启 nginx
 ```
 
-### 参数模板
+批量执行会为每个服务器生成适配其环境的命令，并发执行。
 
-支持动态参数，让别名更灵活：
+**远程历史：**
 
 ```bash
-# 添加带参数的别名
-pls alias add taillog "查看 {{file}} 的最后 {{lines:20}} 行日志"
-
-# 使用时传参
-pls taillog --file=/var/log/system.log                # lines 使用默认值 20
-pls taillog --file=/var/log/system.log --lines=50     # 自定义 lines
-pls taillog file=/var/log/nginx.log lines=100         # 不带 -- 也可以
+pls remote history show myserver        # 查看
+pls remote history clear myserver       # 清空
+pls remote hook install myserver        # 安装远程 Hook
 ```
 
-参数格式说明：
-- `{{param}}` - 必填参数，不提供会报错
-- `{{param:default}}` - 可选参数，有默认值
-
-### 别名 + 额外描述
+### 配置
 
-别名后可以追加额外的描述：
+查看和修改配置：
 
 ```bash
-pls disk 显示详情      # 等同于 pls 查看磁盘使用情况，按使用率排序 显示详情
+pls config           # 交互式配置
+pls config list      # 查看配置
+pls config set <key> <value>  # 修改单项
 ```
 
-## 🚀 版本升级
+主要配置项：
+- `apiKey` / `baseUrl` / `provider` / `model` - AI API 配置
+- `editMode` - 命令编辑模式（manual / auto）
+- `theme` - 界面主题
+- `shellHook` - 是否启用 Shell Hook
+- `chatHistoryLimit` / `commandHistoryLimit` - 历史条数限制
 
-### 自动更新提示
-
-程序会每 24 小时检查一次新版本，发现更新时在命令结束后提示：
-
-```
-⚠ 发现新版本: 1.1.0 → 1.2.0，运行 pls upgrade 更新
-```
+支持的 Provider：openai、deepseek、anthropic、google、groq、mistral、cohere、fireworks、together
 
-### 升级命令
+### 升级
 
 ```bash
-# 升级到最新版本
-pls upgrade
+pls upgrade  # 升级到最新版本
 ```
 
-升级方式：
-- **二进制安装**（curl/irm）：自动下载并替换
-- **npm 安装**：提示使用 `npm update -g @yivan-lab/pretty-please`
-
-## 🎯 命令参考
+程序每 24 小时自动检查更新，发现新版本会提示。
 
-### 基础命令
+## 命令速查
 
 ```bash
-pls <自然语言描述>      # 生成并执行命令
-pls -d <描述>           # Debug 模式（显示完整提示词）
-pls --debug <描述>      # 同上
-pls -v                  # 查看版本
-pls -h                  # 查看帮助
-```
+# 基础
+pls <需求>                  # 生成并执行命令
+pls -d <需求>               # Debug 模式
+pls -v                      # 查看版本
 
-### 子命令
-
-```bash
 # 配置
-pls config
-pls config list
-pls config set <key> <value>
+pls config                  # 交互式配置
+pls config list             # 查看配置
+pls config set <key> <val>  # 修改配置
 
 # 历史
-pls history              # 命令历史
-pls history clear        # 清空命令历史
-pls history chat         # 对话历史
-pls history chat clear   # 清空对话历史
-pls history shell        # Shell 历史
-pls history shell clear  # 清空 Shell 历史
+pls history                 # 命令历史
+pls history chat            # 对话历史
+pls history shell           # Shell 历史
+pls history clear           # 清空历史
 
 # 对话
-pls chat <问题>
-pls chat clear
+pls chat <问题>             # 问问题
+pls history chat clear      # 清空对话
 
-# Shell Hook
-pls hook
-pls hook install
-pls hook uninstall
-pls hook status
+# Hook
+pls hook install            # 安装
+pls hook status             # 状态
+pls hook uninstall          # 卸载
 
 # 主题
-pls theme                # 查看当前主题
-pls theme list           # 查看所有主题
-pls theme <name>         # 切换主题（dark/light/nord/dracula/retro/contrast/monokai）
-
-# 自定义主题
-pls theme create <name> --display-name "名称" # 创建主题模板
-pls theme validate <file>                    # 验证主题文件
-pls theme list --custom                      # 只显示自定义主题
-pls theme list --builtin                     # 只显示内置主题
+pls theme                   # 当前主题
+pls theme list              # 所有主题
+pls theme <name>            # 切换
 
 # 别名
-pls alias                # 查看所有别名
-pls alias list           # 同上
-pls alias add <name> "<prompt>"  # 添加别名
-pls alias remove <name>  # 删除别名
-
-# 升级
-pls upgrade              # 升级到最新版本
-```
-
-## 🏗️ 技术架构
-
-### 核心技术栈
-
-- **React 19 + Ink 6** - 终端 UI 组件化框架
-- **Mastra 0.24** - AI Agent 框架，支持 Structured Output
-- **TypeScript 5.9** - 100% TypeScript，完整类型安全
-- **Zod 3.25** - Schema 验证
-- **Commander 14** - CLI 参数解析
+pls alias                   # 查看
+pls alias add <name> "<prompt>"  # 添加
+pls alias remove <name>     # 删除
 
-## 📁 目录结构
+# 远程
+pls remote add <name> <user@host>  # 添加服务器
+pls remote list             # 查看
+pls -r <name> <需求>        # 远程执行
+pls -r <n1,n2,n3> <需求>    # 批量执行
 
+# 升级
+pls upgrade                 # 升级到最新版本
 ```
-pretty-please/
-├── bin/
-│   └── pls.tsx              # 主入口
-├── src/
-│   ├── prompts.ts           # 统一 AI 提示词管理
-│   ├── mastra-agent.ts      # Mastra Agent（命令生成）
-│   ├── mastra-chat.ts       # Mastra Chat Agent（对话模式）
-│   ├── multi-step.ts        # 多步骤命令核心
-│   ├── config.ts            # 配置管理
-│   ├── history.ts           # 命令历史
-│   ├── chat-history.ts      # 对话历史
-│   ├── shell-hook.ts        # Shell 集成
-│   ├── builtin-detector.ts  # Shell builtin 检测
-│   ├── sysinfo.ts           # 系统信息采集
-│   ├── upgrade.ts           # 版本升级模块
-│   ├── alias.ts             # 命令别名管理
-│   ├── components/          # React Ink 组件
-│   │   ├── MultiStepCommandGenerator.tsx
-│   │   ├── Chat.tsx
-│   │   ├── MarkdownDisplay.tsx
-│   │   └── ...
-│   ├── ui/
-│   │   └── theme.ts         # 主题系统
-│   └── utils/
-│       └── console.ts       # 原生输出工具
-├── package.json
-└── tsconfig.json
-```
-
-## 🔨 开发指南
 
-### 命令版本
+## 技术栈
 
-| 命令 | 类型 | 说明 |
-|------|------|------|
-| `pls` / `please` | 生产版本 | 编译后的 JS |
-| `pls-dev` | 开发版本 | 热重载，代码修改立即生效 |
+- **React + Ink** - 终端 UI 组件化
+- **Mastra** - AI Agent 框架
+- **TypeScript** - 100% 类型安全
+- **Commander** - CLI 参数解析
 
-### 首次设置
+## 开发
 
 ```bash
-# 1. 安装依赖
+git clone https://github.com/IvanLark/pretty-please.git
+cd pretty-please
 pnpm install
-
-# 2. 构建并链接生产版本
 pnpm build
 pnpm link --global
-
-# 3. 创建开发版本链接（需要全局安装 tsx）
-pnpm add -g tsx
-pnpm link:dev
 ```
 
-### 开发模式
+开发模式（热重载）：
 
 ```bash
-# 使用开发命令（推荐，热重载）
-pls-dev <命令>
-
-# 或使用 dev 脚本
-pnpm dev <参数>
-```
-
-代码修改会立即生效，无需重新编译。
-
-### 构建和发布
-
-```bash
-# 构建
-pnpm build
-
-# 发布到 npm（会自动先执行 build）
-npm publish
+pnpm add -g tsx
+pnpm link:dev
+pls-dev <命令>  # 代码修改立即生效
 ```
 
-### 目录说明
-
-- 配置文件：`~/.please/config.json`
-- 命令历史：`~/.please/history.json`
-- 对话历史：`~/.please/chat_history.json`
-- Shell 历史：`~/.please/shell_history.jsonl`
-
-## 🐛 常见问题
-
-### 为什么 Chat 会清空终端历史？
-
-这是 Ink 的设计局限。我们采用了混合渲染模式，命令执行使用原生输出来保留历史，只有 Chat 模式会清空。
+## 常见问题
 
-### AI 返回的命令格式不对？
+**为什么 Chat 会清空终端历史？**
 
-如果遇到 AI 不遵守格式的情况，可以：
-1. 使用 `--debug` 查看完整提示词
-2. 检查 provider 和 model 配置是否正确
-3. 某些模型需要 `jsonPromptInjection`（代码已自动处理）
+这是 Ink 的设计局限。命令执行使用原生输出保留历史，只有 Chat 模式会清空。
 
-### 为什么要用 Zod 3.x？
+**支持哪些 AI？**
 
-AI SDK 和 Mastra 依赖 Zod 3.23.8+，Zod 4.x 有 breaking changes 不兼容。
+支持 OpenAI、DeepSeek、Claude、Gemini、Groq、Mistral、Cohere 等，只要兼容 OpenAI API 格式就行。
 
-## 📄 许可证
+## 许可证
 
 MIT
 
-## 🙏 致谢
+## 致谢
 
-- [fuckit.sh](https://github.com/faithleysath/fuckit.sh) - 提供了最初的灵感和思路，一个优雅的 AI 命令行工具
+- [thefuck](https://github.com/nvbn/thefuck) - 启发了自动修复功能，一个超火的命令纠错工具
+- [fuckit.sh](https://github.com/faithleysath/fuckit.sh) - 提供了灵感，一个优雅的 AI 命令行工具
 - [Ink](https://github.com/vadimdemedes/ink) - 终端 React 渲染器
 - [Mastra](https://mastra.ai) - AI Agent 框架