@yivan-lab/pretty-please 1.0.0 → 1.2.0

package/src/multi-step.ts

@@ -1,19 +1,22 @@
 import { z } from 'zod'
 import { createShellAgent } from './mastra-agent.js'
-import { buildSystemPrompt } from './ai.js'
+import { buildCommandSystemPrompt } from './prompts.js'
 import { formatSystemInfo } from './sysinfo.js'
 import { formatHistoryForAI } from './history.js'
 import { formatShellHistoryForAI, getShellHistory } from './shell-hook.js'
-import { getConfig } from './config.js'
+import { getConfig, type RemoteSysInfo } from './config.js'
+import { formatRemoteHistoryForAI, formatRemoteShellHistoryForAI, type RemoteShellHistoryItem } from './remote-history.js'
+import { formatRemoteSysInfoForAI } from './remote.js'
 
 /**
  * 多步骤命令的 Zod Schema
+ * 注意：optional 字段使用 .default() 是为了绕过 Mastra 0.24.8 对 optional 字段的验证 bug
  */
 export const CommandStepSchema = z.object({
   command: z.string(),
-  continue: z.boolean().optional(),  // 可选！没有 continue = 单步模式
-  reasoning: z.string().optional(),
-  nextStepHint: z.string().optional(),
+  continue: z.boolean().optional().default(false),
+  reasoning: z.string().optional().default(''),
+  nextStepHint: z.string().optional().default(''),
 })
 
 export type CommandStep = z.infer<typeof CommandStepSchema>
@@ -26,6 +29,15 @@ export interface ExecutedStep extends CommandStep {
   output: string
 }
 
+/**
+ * 远程执行上下文
+ */
+export interface RemoteContext {
+  name: string
+  sysInfo: RemoteSysInfo
+  shellHistory: RemoteShellHistoryItem[]
+}
+
 /**
  * 生成系统上下文信息（供 Mastra 使用）
  */
@@ -36,7 +48,24 @@ export function getFullSystemPrompt() {
   const shellHistory = formatShellHistoryForAI()
   const shellHookEnabled = config.shellHook && getShellHistory().length > 0
 
-  return buildSystemPrompt(sysinfo, plsHistory, shellHistory, shellHookEnabled)
+  return buildCommandSystemPrompt(sysinfo, plsHistory, shellHistory, shellHookEnabled)
+}
+
+/**
+ * 生成远程系统上下文信息
+ */
+export function getRemoteFullSystemPrompt(remoteContext: RemoteContext) {
+  // 格式化远程系统信息
+  const sysinfo = formatRemoteSysInfoForAI(remoteContext.name, remoteContext.sysInfo)
+
+  // 格式化远程 pls 命令历史
+  const plsHistory = formatRemoteHistoryForAI(remoteContext.name)
+
+  // 格式化远程 shell 历史
+  const shellHistory = formatRemoteShellHistoryForAI(remoteContext.shellHistory)
+  const shellHookEnabled = remoteContext.shellHistory.length > 0
+
+  return buildCommandSystemPrompt(sysinfo, plsHistory, shellHistory, shellHookEnabled)
 }
 
 /**
@@ -45,10 +74,14 @@ export function getFullSystemPrompt() {
 export async function generateMultiStepCommand(
   userPrompt: string,
   previousSteps: ExecutedStep[] = [],
-  options: { debug?: boolean } = {}
+  options: { debug?: boolean; remoteContext?: RemoteContext } = {}
 ): Promise<{ stepData: CommandStep; debugInfo?: any }> {
   const agent = createShellAgent()
-  const fullSystemPrompt = getFullSystemPrompt()
+
+  // 根据是否有远程上下文选择不同的系统提示词
+  const fullSystemPrompt = options.remoteContext
+    ? getRemoteFullSystemPrompt(options.remoteContext)
+    : getFullSystemPrompt()
 
   // 构建消息数组（string[] 格式）
   const messages: string[] = [userPrompt]
@@ -85,6 +118,10 @@ export async function generateMultiStepCommand(
         userPrompt,
         previousStepsCount: previousSteps.length,
         response: stepData,
+        remoteContext: options.remoteContext ? {
+          name: options.remoteContext.name,
+          sysInfo: options.remoteContext.sysInfo,
+        } : undefined,
       },
     }
   }

package/src/prompts.ts

@@ -0,0 +1,154 @@
+/**
+ * 统一管理所有 AI 系统提示词
+ */
+
+/**
+ * 构建命令生成模式的系统提示词
+ */
+export function buildCommandSystemPrompt(
+  sysinfo: string,
+  plsHistory: string,
+  shellHistory: string,
+  shellHookEnabled: boolean
+): string {
+  let prompt = `你是一个专业的 shell 脚本生成器。用户会提供他们的系统信息和一个命令需求。
+你的任务是返回一个可执行的、原始的 shell 命令或脚本来完成他们的目标。
+
+重要规则：
+1. 返回 JSON 格式，command 字段必须是可直接执行的命令（无解释、无注释、无 markdown）
+2. 不要添加 shebang（如 #!/bin/bash）
+3. command 可以包含多条命令（用 && 连接），但整体算一个命令
+4. 根据用户的系统信息选择合适的命令（如包管理器）
+5. 如果用户引用了之前的操作（如"刚才的"、"上一个"），请参考历史记录
+6. 绝对不要输出 pls 或 please 命令！
+
+【输出格式 - 非常重要】
+
+单步模式（一个命令完成）：
+如果任务只需要一个命令就能完成，只返回：
+{
+  "command": "ls -la"
+}
+
+多步模式（需要多个命令，后续依赖前面的结果）：
+如果任务需要多个命令，且后续命令必须根据前面的执行结果来决定，则返回：
+
+【多步骤完整示例】
+用户："查找大于100MB的日志文件并压缩"
+
+第一步你返回：
+{
+  "command": "find . -name '*.log' -size +100M",
+  "continue": true,
+  "reasoning": "查找大日志", （精简即可）
+  "nextStepHint": "压缩找到的文件" （精简即可）
+}
+
+执行后你会收到：
+命令已执行
+退出码: 0
+输出:
+./app.log
+./system.log
+
+然后你返回第二步：
+{
+  "command": "tar -czf logs.tar.gz ./app.log ./system.log",
+  "continue": false,
+  "reasoning": "压缩日志文件"
+}
+
+关键判断标准：
+- 多步 = 后续命令依赖前面的输出（如先 find 看有哪些，再根据结果操作具体文件）
+- 单步 = 一个命令就能完成（即使命令里有 && 连接多条，也算一个命令）
+
+常见场景举例：
+- "删除空文件夹" → 单步：find . -empty -delete （一个命令完成）
+- "查找大文件并压缩" → 多步：先 find 看有哪些，再 tar 压缩具体文件
+- "安装 git" → 单步：brew install git
+- "备份并删除旧日志" → 多步：先 mkdir backup，再 mv 文件到 backup
+- "查看目录" → 单步：ls -la
+
+严格要求：单步模式只返回 {"command": "xxx"}，绝对不要输出 continue/reasoning/nextStepHint！
+
+【错误处理】
+如果你收到命令执行失败的信息（退出码非0），你应该：
+1. 分析错误原因
+2. 调整命令策略，返回修正后的命令
+3. 设置 continue: true 重试，或设置 continue: false 放弃
+
+错误处理示例：
+上一步失败，你收到：
+命令已执行
+退出码: 1
+输出:
+mv: rename ./test.zip to ./c/test.zip: No such file or directory
+
+你分析后返回修正：
+{
+  "command": "cp test.zip a/ && cp test.zip b/ && cp test.zip c/",
+  "continue": false,
+  "reasoning": "改用 cp 复制而非 mv"
+}
+
+或者如果决定放弃（无法修正），返回：
+{
+  "command": "",
+  "continue": false,
+  "reasoning": "文件不存在且无法恢复，任务无法继续"
+}
+
+重要：当 continue: false 且决定放弃时，command 可以留空，重点是在 reasoning 中说明为什么放弃。
+
+关于 pls/please 工具：
+用户正在使用 pls（pretty-please）工具，这是一个将自然语言转换为 shell 命令的 AI 助手。
+当用户输入 "pls <描述>" 时，AI（也就是你）会生成对应的 shell 命令供用户确认执行。
+历史记录中标记为 [pls] 的条目表示用户通过 pls 工具执行的命令。
+
+用户的系统信息：${sysinfo}`
+
+  // 根据是否启用 shell hook 决定展示哪个历史
+  if (shellHookEnabled && shellHistory) {
+    prompt += `\n\n${shellHistory}`
+  } else if (plsHistory) {
+    prompt += `\n\n${plsHistory}`
+  }
+
+  return prompt
+}
+
+/**
+ * 构建 Chat 对话模式的系统提示词
+ */
+export function buildChatSystemPrompt(
+  sysinfo: string,
+  plsHistory: string,
+  shellHistory: string,
+  shellHookEnabled: boolean
+): string {
+  let prompt = `你是一个命令行专家助手，帮助用户理解和使用命令行工具。
+
+【你的能力】
+- 解释命令的含义、参数、用法
+- 分析命令的执行效果和潜在风险
+- 回答命令行、Shell、系统管理相关问题
+- 根据用户需求推荐合适的命令并解释
+
+【回答要求】
+- 简洁清晰，避免冗余
+- 危险操作要明确警告
+- 适当给出示例命令
+- 结合用户的系统环境给出针对性建议
+
+【用户系统信息】
+${sysinfo}`
+
+  // 根据是否启用 shell hook 决定展示哪个历史
+  if (shellHookEnabled && shellHistory) {
+    prompt += `\n\n${shellHistory}`
+  } else if (plsHistory) {
+    prompt += `\n\n${plsHistory}`
+  }
+
+  return prompt
+}

package/src/remote-history.ts

@@ -0,0 +1,390 @@
+/**
+ * 远程服务器历史管理模块
+ * 管理每个远程服务器的命令历史
+ */
+
+import fs from 'fs'
+import path from 'path'
+import chalk from 'chalk'
+import { CONFIG_DIR, getConfig } from './config.js'
+import { getCurrentTheme } from './ui/theme.js'
+import { sshExec, getRemote } from './remote.js'
+
+// 获取主题颜色
+function getColors() {
+  const theme = getCurrentTheme()
+  return {
+    primary: theme.primary,
+    secondary: theme.secondary,
+    success: theme.success,
+    error: theme.error,
+    warning: theme.warning,
+    muted: theme.text.muted,
+  }
+}
+
+// 远程服务器数据目录
+const REMOTES_DIR = path.join(CONFIG_DIR, 'remotes')
+
+/**
+ * 远程命令历史记录
+ */
+export interface RemoteHistoryRecord {
+  userPrompt: string
+  command: string
+  aiGeneratedCommand?: string  // AI 原始命令
+  userModified?: boolean       // 用户是否修改
+  executed: boolean
+  exitCode: number | null
+  output: string
+  timestamp: string
+  reason?: string              // 未执行原因
+}
+
+/**
+ * Shell 历史记录项
+ */
+export interface RemoteShellHistoryItem {
+  cmd: string
+  exit: number
+  time: string
+}
+
+// ================== 命令历史管理 ==================
+
+/**
+ * 获取远程服务器历史文件路径
+ */
+function getRemoteHistoryPath(name: string): string {
+  return path.join(REMOTES_DIR, name, 'history.json')
+}
+
+/**
+ * 获取远程服务器命令历史
+ */
+export function getRemoteHistory(name: string): RemoteHistoryRecord[] {
+  const historyPath = getRemoteHistoryPath(name)
+
+  if (!fs.existsSync(historyPath)) {
+    return []
+  }
+
+  try {
+    const content = fs.readFileSync(historyPath, 'utf-8')
+    return JSON.parse(content) as RemoteHistoryRecord[]
+  } catch {
+    return []
+  }
+}
+
+/**
+ * 添加远程命令历史记录
+ */
+export function addRemoteHistory(name: string, record: Omit<RemoteHistoryRecord, 'timestamp'>): void {
+  const config = getConfig()
+  const historyPath = getRemoteHistoryPath(name)
+
+  // 确保目录存在
+  const dir = path.dirname(historyPath)
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true })
+  }
+
+  let history = getRemoteHistory(name)
+
+  // 添加新记录
+  history.push({
+    ...record,
+    timestamp: new Date().toISOString(),
+  })
+
+  // 限制历史数量
+  const limit = config.commandHistoryLimit || 10
+  if (history.length > limit) {
+    history = history.slice(-limit)
+  }
+
+  fs.writeFileSync(historyPath, JSON.stringify(history, null, 2))
+}
+
+/**
+ * 清空远程命令历史
+ */
+export function clearRemoteHistory(name: string): void {
+  const historyPath = getRemoteHistoryPath(name)
+  if (fs.existsSync(historyPath)) {
+    fs.unlinkSync(historyPath)
+  }
+}
+
+/**
+ * 格式化远程命令历史供 AI 使用
+ */
+export function formatRemoteHistoryForAI(name: string): string {
+  const history = getRemoteHistory(name)
+
+  if (history.length === 0) {
+    return ''
+  }
+
+  const lines = history.map((record, index) => {
+    let status = ''
+    if (record.reason === 'builtin') {
+      status = '(包含 builtin，未执行)'
+    } else if (record.executed) {
+      status = record.exitCode === 0 ? '✓' : `✗ 退出码:${record.exitCode}`
+    } else {
+      status = '(用户取消执行)'
+    }
+
+    // 显示用户修改信息
+    if (record.userModified && record.aiGeneratedCommand) {
+      return `${index + 1}. "${record.userPrompt}" → AI 生成: ${record.aiGeneratedCommand} / 用户修改为: ${record.command} ${status}`
+    } else {
+      return `${index + 1}. "${record.userPrompt}" → ${record.command} ${status}`
+    }
+  })
+
+  return `【该服务器最近通过 pls 执行的命令】\n${lines.join('\n')}`
+}
+
+/**
+ * 显示远程命令历史
+ */
+export function displayRemoteHistory(name: string): void {
+  const remote = getRemote(name)
+  const history = getRemoteHistory(name)
+  const colors = getColors()
+
+  if (!remote) {
+    console.log('')
+    console.log(chalk.hex(colors.error)(`✗ 服务器 "${name}" 不存在`))
+    console.log('')
+    return
+  }
+
+  console.log('')
+
+  if (history.length === 0) {
+    console.log(chalk.gray(`  服务器 "${name}" 暂无命令历史`))
+    console.log('')
+    return
+  }
+
+  console.log(chalk.bold(`📜 服务器 "${name}" 命令历史:`))
+  console.log(chalk.gray('━'.repeat(50)))
+
+  history.forEach((item, index) => {
+    const status = item.executed
+      ? item.exitCode === 0
+        ? chalk.hex(colors.success)('✓')
+        : chalk.hex(colors.error)(`✗ 退出码:${item.exitCode}`)
+      : chalk.gray('(未执行)')
+
+    console.log(`\n${chalk.gray(`${index + 1}.`)} ${chalk.hex(colors.primary)(item.userPrompt)}`)
+
+    // 显示用户修改信息
+    if (item.userModified && item.aiGeneratedCommand) {
+      console.log(`   ${chalk.dim('AI 生成:')} ${chalk.gray(item.aiGeneratedCommand)}`)
+      console.log(`   ${chalk.dim('用户修改为:')} ${item.command} ${status} ${chalk.hex(colors.warning)('(已修改)')}`)
+    } else {
+      console.log(`   ${chalk.dim('→')} ${item.command} ${status}`)
+    }
+
+    console.log(`   ${chalk.gray(item.timestamp)}`)
+  })
+
+  console.log('')
+  console.log(chalk.gray('━'.repeat(50)))
+  console.log(chalk.gray(`历史文件: ${getRemoteHistoryPath(name)}`))
+  console.log('')
+}
+
+// ================== Shell 历史管理 ==================
+
+// 远程 shell 历史的本地缓存文件
+function getRemoteShellHistoryPath(name: string): string {
+  return path.join(REMOTES_DIR, name, 'shell_history.jsonl')
+}
+
+/**
+ * 从远程服务器读取 shell 历史
+ * 读取远程 ~/.please/shell_history.jsonl
+ */
+export async function fetchRemoteShellHistory(name: string): Promise<RemoteShellHistoryItem[]> {
+  const config = getConfig()
+  const limit = config.shellHistoryLimit || 15
+
+  try {
+    // 读取远程 shell 历史文件
+    const result = await sshExec(name, `tail -n ${limit} ~/.please/shell_history.jsonl 2>/dev/null || echo ""`, {
+      timeout: 10000,
+    })
+
+    if (result.exitCode !== 0 || !result.stdout.trim()) {
+      return []
+    }
+
+    const lines = result.stdout.trim().split('\n').filter(line => line.trim())
+    const items: RemoteShellHistoryItem[] = []
+
+    for (const line of lines) {
+      try {
+        const item = JSON.parse(line) as RemoteShellHistoryItem
+        items.push(item)
+      } catch {
+        // 跳过无效行
+      }
+    }
+
+    // 缓存到本地
+    saveRemoteShellHistoryCache(name, items)
+
+    return items
+  } catch {
+    // 如果无法连接，尝试返回缓存
+    return getRemoteShellHistoryCache(name)
+  }
+}
+
+/**
+ * 保存远程 shell 历史缓存到本地
+ */
+function saveRemoteShellHistoryCache(name: string, items: RemoteShellHistoryItem[]): void {
+  const cachePath = getRemoteShellHistoryPath(name)
+
+  // 确保目录存在
+  const dir = path.dirname(cachePath)
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true })
+  }
+
+  const content = items.map(item => JSON.stringify(item)).join('\n')
+  fs.writeFileSync(cachePath, content)
+}
+
+/**
+ * 获取本地缓存的远程 shell 历史
+ */
+function getRemoteShellHistoryCache(name: string): RemoteShellHistoryItem[] {
+  const cachePath = getRemoteShellHistoryPath(name)
+
+  if (!fs.existsSync(cachePath)) {
+    return []
+  }
+
+  try {
+    const content = fs.readFileSync(cachePath, 'utf-8')
+    const lines = content.trim().split('\n').filter(line => line.trim())
+
+    return lines.map(line => {
+      try {
+        return JSON.parse(line) as RemoteShellHistoryItem
+      } catch {
+        return null
+      }
+    }).filter((item): item is RemoteShellHistoryItem => item !== null)
+  } catch {
+    return []
+  }
+}
+
+/**
+ * 格式化远程 shell 历史供 AI 使用
+ */
+export function formatRemoteShellHistoryForAI(items: RemoteShellHistoryItem[]): string {
+  if (items.length === 0) {
+    return ''
+  }
+
+  const lines = items.map((item, index) => {
+    const status = item.exit === 0 ? '✓' : `✗ 退出码:${item.exit}`
+    return `${index + 1}. ${item.cmd} ${status}`
+  })
+
+  return `【该服务器终端最近执行的命令】\n${lines.join('\n')}`
+}
+
+/**
+ * 显示远程 shell 历史
+ */
+export async function displayRemoteShellHistory(name: string): Promise<void> {
+  const remote = getRemote(name)
+  const colors = getColors()
+
+  if (!remote) {
+    console.log('')
+    console.log(chalk.hex(colors.error)(`✗ 服务器 "${name}" 不存在`))
+    console.log('')
+    return
+  }
+
+  console.log('')
+  console.log(chalk.gray(`正在从 ${name} 读取 shell 历史...`))
+
+  try {
+    const history = await fetchRemoteShellHistory(name)
+
+    if (history.length === 0) {
+      console.log('')
+      console.log(chalk.gray(`  服务器 "${name}" 暂无 shell 历史`))
+      console.log(chalk.gray('  请先安装远程 hook: pls remote hook install ' + name))
+      console.log('')
+      return
+    }
+
+    console.log('')
+    console.log(chalk.bold(`终端历史 - ${name}（最近 ${history.length} 条）:`))
+    console.log(chalk.gray('━'.repeat(50)))
+
+    history.forEach((item, index) => {
+      const num = index + 1
+      const status = item.exit === 0 ? chalk.hex(colors.success)('✓') : chalk.hex(colors.error)(`✗ (${item.exit})`)
+      console.log(`  ${chalk.hex(colors.primary)(num.toString().padStart(2, ' '))}. ${item.cmd} ${status}`)
+    })
+
+    console.log(chalk.gray('━'.repeat(50)))
+    console.log(chalk.gray(`远程文件: ~/.please/shell_history.jsonl`))
+    console.log('')
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error)
+    console.log('')
+    console.log(chalk.hex(colors.error)(`✗ 无法读取远程 shell 历史: ${message}`))
+    console.log('')
+  }
+}
+
+/**
+ * 清空远程 shell 历史
+ */
+export async function clearRemoteShellHistory(name: string): Promise<void> {
+  const remote = getRemote(name)
+  const colors = getColors()
+
+  if (!remote) {
+    console.log('')
+    console.log(chalk.hex(colors.error)(`✗ 服务器 "${name}" 不存在`))
+    console.log('')
+    return
+  }
+
+  try {
+    // 清空远程文件
+    await sshExec(name, 'rm -f ~/.please/shell_history.jsonl', { timeout: 10000 })
+
+    // 清空本地缓存
+    const cachePath = getRemoteShellHistoryPath(name)
+    if (fs.existsSync(cachePath)) {
+      fs.unlinkSync(cachePath)
+    }
+
+    console.log('')
+    console.log(chalk.hex(colors.success)(`✓ 服务器 "${name}" 的 shell 历史已清空`))
+    console.log('')
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error)
+    console.log('')
+    console.log(chalk.hex(colors.error)(`✗ 无法清空远程 shell 历史: ${message}`))
+    console.log('')
+  }
+}