@yivan-lab/pretty-please 1.0.0 → 1.1.0

package/README.md

@@ -9,8 +9,9 @@
 - 🤖 **自然语言转命令** - 用人话说你想干什么，AI 自动生成命令
 - 🔄 **多步骤命令** - AI 自动规划多个步骤，后续命令依赖前面的执行结果
 - 🛡️ **智能错误恢复** - 命令失败时 AI 自动分析并调整策略
+- ✏️ **命令编辑** - 执行前可编辑 AI 生成的命令，支持 manual/auto 两种模式
 - 💬 **AI 对话模式** - 随时问 AI 命令怎么用
-- 📜 **历史记录** - 保存执行过的命令，方便复用
+- 📜 **三种历史记录** - 命令历史、对话历史、Shell 历史统一管理
 - 🎨 **精美界面** - 基于 React + Ink 的终端 UI，Markdown 渲染
 - 🔧 **多 Provider 支持** - 支持 OpenAI、DeepSeek、Anthropic 等多种 AI
 
@@ -29,13 +30,7 @@ pnpm add -g @yivan-lab/pretty-please
 yarn global add @yivan-lab/pretty-please
 ```
 
-安装后，确保全局安装了 `tsx`：
-
-```bash
-npm install -g tsx
-# 或
-pnpm add -g tsx
-```
+安装完成后，你可以在任何目录使用 `pls` 或 `please` 命令了！
 
 ### 方式二：从源码安装
 
@@ -47,11 +42,11 @@ cd pretty-please
 # 安装依赖
 pnpm install
 
+# 构建
+pnpm build
+
 # 全局链接
 pnpm link --global
-
-# 确保全局安装了 tsx
-pnpm add -g tsx
 ```
 
 安装完成后，你可以在任何目录使用 `pls` 或 `please` 命令了！
@@ -159,6 +154,37 @@ pls 将 test.zip 移动到 a、b、c 三个文件夹
 
 AI 不会因为一次失败就放弃，而是理解错误原因并找到解决方案。
 
+### 命令编辑
+
+AI 生成的命令可能不完全符合你的需求，你可以在执行前编辑它：
+
+**manual 模式（默认）**：
+
+```
+┌─ 生成命令 ───────┐
+│ ls -la           │
+└──────────────────┘
+
+执行？ [回车执行 / E 编辑 / Esc 取消]
+
+# 按 E 进入编辑
+┌─ 生成命令 ───────┐
+│ ls -la           │  ← AI 建议
+└──────────────────┘
+> ls -l█            ← 可编辑
+
+[回车执行 / Esc 返回]
+```
+
+**auto 模式**：自动进入编辑，直接修改后执行
+
+```bash
+# 切换到 auto 模式
+pls config set editMode auto
+```
+
+编辑后的命令会被记录到历史中，并标注修改前后的对比。
+
 ### 对话模式：命令讲解和问答
 
 想了解某个命令怎么用？用 `pls chat` 开启对话模式：
@@ -191,16 +217,25 @@ pls chat clear
 ### 查看历史记录
 
 ```bash
-# 查看所有执行过的命令
+# 查看命令历史
 pls history
 
-# 清空历史记录
-pls history clear
+# 查看对话历史
+pls history chat
+
+# 查看 Shell 历史（需要启用 Shell Hook）
+pls history shell
+
+# 清空各种历史
+pls history clear         # 清空命令历史
+pls history chat clear    # 清空对话历史
+pls history shell clear   # 清空 Shell 历史
 ```
 
 历史记录包含：
 - 你的原始需求（自然语言）
 - AI 生成的命令
+- 用户修改后的命令（如有修改）
 - 执行状态（成功/失败/退出码）
 - 执行时间
 
@@ -222,7 +257,10 @@ pls config set <key> <value>  # 设置单个配置项
 | `provider` | AI Provider | `openai` |
 | `model` | 模型名称 | `gpt-4-turbo` |
 | `shellHook` | 启用终端历史记录 | `false` |
+| `editMode` | 命令编辑模式（manual/auto） | `manual` |
 | `chatHistoryLimit` | 对话历史保留轮数 | `10` |
+| `commandHistoryLimit` | 命令历史保留条数 | `10` |
+| `shellHistoryLimit` | Shell 历史保留条数 | `15` |
 
 ### 支持的 Provider
 
@@ -272,8 +310,12 @@ pls config list
 pls config set <key> <value>
 
 # 历史
-pls history
-pls history clear
+pls history              # 命令历史
+pls history clear        # 清空命令历史
+pls history chat         # 对话历史
+pls history chat clear   # 清空对话历史
+pls history shell        # Shell 历史
+pls history shell clear  # 清空 Shell 历史
 
 # 对话
 pls chat <问题>
@@ -292,7 +334,7 @@ pls hook status
 
 - **React 19 + Ink 6** - 终端 UI 组件化框架
 - **Mastra 0.24** - AI Agent 框架，支持 Structured Output
-- **TypeScript 5.9** - 类型安全
+- **TypeScript 5.9** - 100% TypeScript，完整类型安全
 - **Zod 3.25** - Schema 验证
 - **Commander 14** - CLI 参数解析
 
@@ -303,31 +345,56 @@ pretty-please/
 ├── bin/
 │   └── pls.tsx              # 主入口
 ├── src/
-│   ├── ai.js                # OpenAI 客户端 + 提示词
-│   ├── mastra-agent.ts      # Mastra Agent 配置
+│   ├── prompts.ts           # 统一 AI 提示词管理
+│   ├── mastra-agent.ts      # Mastra Agent（命令生成）
+│   ├── mastra-chat.ts       # Mastra Chat Agent（对话模式）
 │   ├── multi-step.ts        # 多步骤命令核心
-│   ├── config.js            # 配置管理
-│   ├── history.js           # 命令历史
-│   ├── chat-history.js      # 对话历史
-│   ├── shell-hook.js        # Shell 集成
+│   ├── config.ts            # 配置管理
+│   ├── history.ts           # 命令历史
+│   ├── chat-history.ts      # 对话历史
+│   ├── shell-hook.ts        # Shell 集成
+│   ├── builtin-detector.ts  # Shell builtin 检测
+│   ├── sysinfo.ts           # 系统信息采集
 │   ├── components/          # React Ink 组件
 │   │   ├── MultiStepCommandGenerator.tsx
 │   │   ├── Chat.tsx
 │   │   ├── MarkdownDisplay.tsx
 │   │   └── ...
 │   └── utils/
-│       └── console.js       # 原生输出工具
+│       └── console.ts       # 原生输出工具
 ├── package.json
 └── tsconfig.json
 ```
 
 ## 🔨 开发指南
 
+### 命令版本
+
+| 命令 | 类型 | 说明 |
+|------|------|------|
+| `pls` / `please` | 生产版本 | 编译后的 JS |
+| `pls-dev` | 开发版本 | 热重载，代码修改立即生效 |
+
+### 首次设置
+
+```bash
+# 1. 安装依赖
+pnpm install
+
+# 2. 构建并链接生产版本
+pnpm build
+pnpm link --global
+
+# 3. 创建开发版本链接（需要全局安装 tsx）
+pnpm add -g tsx
+pnpm link:dev
+```
+
 ### 开发模式
 
 ```bash
-# 直接运行（热重载）
-pls <命令>
+# 使用开发命令（推荐，热重载）
+pls-dev <命令>
 
 # 或使用 dev 脚本
 pnpm dev <参数>
@@ -335,10 +402,14 @@ pnpm dev <参数>
 
 代码修改会立即生效，无需重新编译。
 
-### 编译
+### 构建和发布
 
 ```bash
+# 构建
 pnpm build
+
+# 发布到 npm（会自动先执行 build）
+npm publish
 ```
 
 ### 目录说明

package/bin/pls.tsx

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env tsx
 import React from 'react'
 import { render } from 'ink'
 import { Command } from 'commander'
@@ -8,12 +8,11 @@ import { exec } from 'child_process'
 import fs from 'fs'
 import os from 'os'
 import chalk from 'chalk'
-import { CommandGenerator } from '../src/components/CommandGenerator.js'
 import { MultiStepCommandGenerator } from '../src/components/MultiStepCommandGenerator.js'
 import { Chat } from '../src/components/Chat.js'
 import { isConfigValid, setConfigValue, getConfig, maskApiKey } from '../src/config.js'
 import { clearHistory, addHistory, getHistory, getHistoryFilePath } from '../src/history.js'
-import { clearChatHistory, getChatRoundCount, getChatHistoryFilePath } from '../src/chat-history.js'
+import { clearChatHistory, getChatRoundCount, getChatHistoryFilePath, displayChatHistory } from '../src/chat-history.js'
 import { type ExecutedStep } from '../src/multi-step.js'
 import {
   installShellHook,
@@ -21,26 +20,34 @@ import {
   getHookStatus,
   detectShell,
   getShellConfigPath,
+  displayShellHistory,
+  clearShellHistory,
 } from '../src/shell-hook.js'
 import * as console2 from '../src/utils/console.js'
+// 导入 package.json（Bun 会自动打包进二进制）
+import packageJson from '../package.json'
 
-// 获取 package.json 版本
+// 保留这些用于其他可能的用途
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
-const packageJson = JSON.parse(fs.readFileSync(join(__dirname, '../package.json'), 'utf-8'))
 
 const program = new Command()
 
 /**
  * 执行命令（原生版本）
  */
-function executeCommand(command: string, prompt: string): Promise<{ exitCode: number; output: string }> {
+function executeCommand(command: string): Promise<{ exitCode: number; output: string }> {
   return new Promise((resolve) => {
     let output = ''
     let hasOutput = false
 
     console.log('') // 空行
-    console2.printSeparator('输出')
+
+    // 计算命令框宽度，让分隔线长度一致
+    const lines = command.split('\n')
+    const maxContentWidth = Math.max(...lines.map(l => console2.getDisplayWidth(l)))
+    const boxWidth = Math.max(maxContentWidth + 4, console2.getDisplayWidth('生成命令') + 6, 20)
+    console2.printSeparator('输出', boxWidth)
 
     const child = exec(command)
 
@@ -58,17 +65,17 @@ function executeCommand(command: string, prompt: string): Promise<{ exitCode: nu
 
     child.on('close', (code) => {
       if (hasOutput) {
-        console2.printSeparator('')
+        console2.printSeparator('', boxWidth)
       }
       resolve({ exitCode: code || 0, output })
     })
 
     child.on('error', (err) => {
       if (!hasOutput) {
-        console2.printSeparator('')
+        console2.printSeparator('', boxWidth)
       }
       console2.error(err.message)
-      console2.printSeparator('')
+      console2.printSeparator('', boxWidth)
       resolve({ exitCode: 1, output: err.message })
     })
   })
@@ -94,18 +101,25 @@ configCmd
 
     console.log('')
     console2.title('当前配置:')
-    console2.muted('━'.repeat(40))
-    console.log(`  ${chalk.hex('#00D9FF')('apiKey')}:           ${maskApiKey(config.apiKey)}`)
-    console.log(`  ${chalk.hex('#00D9FF')('baseUrl')}:          ${config.baseUrl}`)
-    console.log(`  ${chalk.hex('#00D9FF')('provider')}:         ${config.provider}`)
-    console.log(`  ${chalk.hex('#00D9FF')('model')}:            ${config.model}`)
+    console2.muted('━'.repeat(50))
+    console.log(`  ${chalk.hex('#00D9FF')('apiKey')}:              ${maskApiKey(config.apiKey)}`)
+    console.log(`  ${chalk.hex('#00D9FF')('baseUrl')}:             ${config.baseUrl}`)
+    console.log(`  ${chalk.hex('#00D9FF')('provider')}:            ${config.provider}`)
+    console.log(`  ${chalk.hex('#00D9FF')('model')}:               ${config.model}`)
     console.log(
-      `  ${chalk.hex('#00D9FF')('shellHook')}:        ${
+      `  ${chalk.hex('#00D9FF')('shellHook')}:           ${
         config.shellHook ? chalk.hex('#10B981')('已启用') : chalk.gray('未启用')
       }`
     )
-    console.log(`  ${chalk.hex('#00D9FF')('chatHistoryLimit')}: ${config.chatHistoryLimit} 轮`)
-    console2.muted('━'.repeat(40))
+    console.log(
+      `  ${chalk.hex('#00D9FF')('editMode')}:            ${
+        config.editMode === 'auto' ? chalk.hex('#00D9FF')('auto (自动编辑)') : chalk.gray('manual (按E编辑)')
+      }`
+    )
+    console.log(`  ${chalk.hex('#00D9FF')('chatHistoryLimit')}:    ${config.chatHistoryLimit} 轮`)
+    console.log(`  ${chalk.hex('#00D9FF')('commandHistoryLimit')}: ${config.commandHistoryLimit} 条`)
+    console.log(`  ${chalk.hex('#00D9FF')('shellHistoryLimit')}:   ${config.shellHistoryLimit} 条`)
+    console2.muted('━'.repeat(50))
     console2.muted(`配置文件: ${CONFIG_FILE}`)
     console.log('')
   })
@@ -161,7 +175,15 @@ historyCmd
         : chalk.gray('(未执行)')
 
       console.log(`\n${chalk.gray(`${index + 1}.`)} ${chalk.hex('#00D9FF')(item.userPrompt)}`)
-      console.log(`   ${chalk.dim('→')} ${item.command} ${status}`)
+
+      // 显示用户修改信息
+      if (item.userModified && item.aiGeneratedCommand) {
+        console.log(`   ${chalk.dim('AI 生成:')} ${chalk.gray(item.aiGeneratedCommand)}`)
+        console.log(`   ${chalk.dim('用户修改为:')} ${item.command} ${status} ${chalk.yellow('(已修改)')}`)
+      } else {
+        console.log(`   ${chalk.dim('→')} ${item.command} ${status}`)
+      }
+
       console.log(`   ${chalk.gray(item.timestamp)}`)
     })
 
@@ -180,7 +202,38 @@ historyCmd
     console.log('')
   })
 
-// 默认 history 命令（显示历史）
+// history chat 子命令
+const historyChatCmd = historyCmd.command('chat').description('查看或管理对话历史')
+
+historyChatCmd.action(() => {
+  displayChatHistory()
+})
+
+historyChatCmd
+  .command('clear')
+  .description('清空对话历史')
+  .action(() => {
+    clearChatHistory()
+    console.log('')
+    console2.success('对话历史已清空')
+    console.log('')
+  })
+
+// history shell 子命令
+const historyShellCmd = historyCmd.command('shell').description('查看或管理 Shell 历史')
+
+historyShellCmd.action(() => {
+  displayShellHistory()
+})
+
+historyShellCmd
+  .command('clear')
+  .description('清空 Shell 历史')
+  .action(() => {
+    clearShellHistory()
+  })
+
+// 默认 history 命令（显示命令历史）
 historyCmd.action(() => {
   const history = getHistory()
 
@@ -203,7 +256,15 @@ historyCmd.action(() => {
       : chalk.gray('(未执行)')
 
     console.log(`\n${chalk.gray(`${index + 1}.`)} ${chalk.hex('#00D9FF')(item.userPrompt)}`)
-    console.log(`   ${chalk.dim('→')} ${item.command} ${status}`)
+
+    // 显示用户修改信息
+    if (item.userModified && item.aiGeneratedCommand) {
+      console.log(`   ${chalk.dim('AI 生成:')} ${chalk.gray(item.aiGeneratedCommand)}`)
+      console.log(`   ${chalk.dim('用户修改为:')} ${item.command} ${status} ${chalk.yellow('(已修改)')}`)
+    } else {
+      console.log(`   ${chalk.dim('→')} ${item.command} ${status}`)
+    }
+
     console.log(`   ${chalk.gray(item.timestamp)}`)
   })
 
@@ -411,6 +472,7 @@ program
     ;(async () => {
       const executedSteps: ExecutedStep[] = []
       let currentStepNumber = 1
+      let lastStepFailed = false // 跟踪上一步是否失败
 
       while (true) {
         let stepResult: any = null
@@ -444,6 +506,8 @@ program
           addHistory({
             userPrompt: currentStepNumber === 1 ? prompt : `[步骤${currentStepNumber}] ${prompt}`,
             command: stepResult.command,
+            aiGeneratedCommand: stepResult.aiGeneratedCommand,  // AI 原始命令
+            userModified: stepResult.userModified || false,
             executed: false,
             exitCode: null,
             output: '',
@@ -453,9 +517,35 @@ program
         }
 
         if (stepResult.confirmed) {
+          // 如果命令为空，说明 AI 决定放弃
+          if (!stepResult.command || stepResult.command.trim() === '') {
+            console.log('')
+            if (stepResult.reasoning) {
+              console2.info(`💡 AI 分析: ${stepResult.reasoning}`)
+            }
+            console2.muted('❌ AI 决定停止尝试，任务失败')
+            console.log('')
+            process.exit(1)
+          }
+
+          // 特殊处理：如果上一步失败，且 AI 决定放弃（continue: false），直接显示原因并退出
+          if (
+            lastStepFailed &&
+            stepResult.needsContinue === false &&
+            stepResult.command.startsWith('echo')
+          ) {
+            console.log('')
+            if (stepResult.reasoning) {
+              console2.info(`💡 AI 分析: ${stepResult.reasoning}`)
+            }
+            console2.muted('❌ AI 决定停止尝试，任务失败')
+            console.log('')
+            process.exit(1)
+          }
+
           // 执行命令
           const execStart = Date.now()
-          const { exitCode, output } = await executeCommand(stepResult.command, prompt)
+          const { exitCode, output } = await executeCommand(stepResult.command)
           const execDuration = Date.now() - execStart
 
           // 保存到执行历史
@@ -474,6 +564,8 @@ program
             userPrompt:
               currentStepNumber === 1 ? prompt : `[步骤${currentStepNumber}] ${stepResult.reasoning || prompt}`,
             command: stepResult.command,
+            aiGeneratedCommand: stepResult.aiGeneratedCommand,  // AI 原始命令
+            userModified: stepResult.userModified || false,
             executed: true,
             exitCode,
             output,
@@ -489,14 +581,19 @@ program
               // 多步命令
               console2.success(`步骤 ${currentStepNumber} 执行完成 ${console2.formatDuration(execDuration)}`)
             }
+            lastStepFailed = false
           } else {
-            // 执行失败，但不立即退出，让 AI 分析错误并调整策略
+            // 执行失败，标记状态
             console2.error(
               `步骤 ${currentStepNumber} 执行失败，退出码: ${exitCode} ${console2.formatDuration(execDuration)}`
             )
             console.log('')
             console2.warning('正在请 AI 分析错误并调整策略...')
-            // 不退出，继续循环，AI 会收到错误信息
+            lastStepFailed = true
+            // 继续循环，让 AI 分析错误
+            console.log('')
+            currentStepNumber++
+            continue
           }
 
           // 判断是否继续
@@ -511,6 +608,20 @@ program
 
           console.log('')
           currentStepNumber++
+        } else if (!stepResult.confirmed && !stepResult.cancelled) {
+          // AI 返回了结果但没有确认（空命令的情况）
+          if (lastStepFailed && stepResult.reasoning) {
+            console.log('')
+            console2.info(`💡 AI 分析: ${stepResult.reasoning}`)
+            console2.muted('❌ AI 决定停止尝试，任务失败')
+            console.log('')
+            process.exit(1)
+          }
+          // 其他情况也退出
+          console.log('')
+          console2.muted('任务结束')
+          console.log('')
+          process.exit(0)
         }
       }
     })()

package/dist/bin/pls.d.ts

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
+#!/usr/bin/env tsx
 export {};