@yivan-lab/pretty-please 1.0.0 → 1.1.0

package/src/history.ts

@@ -0,0 +1,160 @@
+import fs from 'fs'
+import path from 'path'
+import os from 'os'
+import { getConfig } from './config.js'
+
+const CONFIG_DIR = path.join(os.homedir(), '.please')
+const HISTORY_FILE = path.join(CONFIG_DIR, 'history.json')
+const MAX_HISTORY = 10
+const MAX_OUTPUT_LENGTH = 500
+
+/**
+ * 历史记录项
+ */
+export interface HistoryRecord {
+  userPrompt: string
+  command: string
+  aiGeneratedCommand?: string
+  userModified?: boolean
+  executed: boolean
+  exitCode: number | null
+  output?: string
+  reason?: 'builtin' | string
+  timestamp?: string
+}
+
+/**
+ * 确保配置目录存在
+ */
+function ensureConfigDir(): void {
+  if (!fs.existsSync(CONFIG_DIR)) {
+    fs.mkdirSync(CONFIG_DIR, { recursive: true })
+  }
+}
+
+/**
+ * 读取历史记录
+ */
+export function getHistory(): HistoryRecord[] {
+  ensureConfigDir()
+
+  if (!fs.existsSync(HISTORY_FILE)) {
+    return []
+  }
+
+  try {
+    const content = fs.readFileSync(HISTORY_FILE, 'utf-8')
+    return JSON.parse(content) as HistoryRecord[]
+  } catch {
+    return []
+  }
+}
+
+/**
+ * 保存历史记录
+ */
+function saveHistory(history: HistoryRecord[]): void {
+  ensureConfigDir()
+  fs.writeFileSync(HISTORY_FILE, JSON.stringify(history, null, 2))
+}
+
+/**
+ * 添加一条历史记录
+ */
+export function addHistory(record: HistoryRecord): void {
+  const config = getConfig()
+  const history = getHistory()
+
+  // 截断输出
+  if (record.output && record.output.length > MAX_OUTPUT_LENGTH) {
+    record.output = record.output.slice(0, MAX_OUTPUT_LENGTH) + '...(截断)'
+  }
+
+  // 添加时间戳
+  record.timestamp = new Date().toISOString()
+
+  // 添加到开头
+  history.unshift(record)
+
+  // 保留最近 N 条（从配置读取）
+  const maxHistory = config.commandHistoryLimit || MAX_HISTORY
+  if (history.length > maxHistory) {
+    history.length = maxHistory
+  }
+
+  saveHistory(history)
+}
+
+/**
+ * 清空历史记录
+ */
+export function clearHistory(): void {
+  saveHistory([])
+}
+
+/**
+ * 格式化历史记录供 AI 使用
+ */
+export function formatHistoryForAI(): string {
+  const history = getHistory()
+
+  if (history.length === 0) {
+    return ''
+  }
+
+  const lines = history
+    .map((item, index) => {
+      const timeAgo = getTimeAgo(item.timestamp || '')
+
+      let status: string
+      if (item.executed) {
+        status = item.exitCode === 0 ? '✓' : `✗ 退出码:${item.exitCode}`
+      } else if (item.reason === 'builtin') {
+        status = '(包含 builtin，未执行)'
+      } else {
+        status = '(用户取消执行)'
+      }
+
+      // 检查是否用户修改了命令
+      if (item.userModified && item.aiGeneratedCommand) {
+        // 用户修改了命令
+        return `${index + 1}. [${timeAgo}] "${item.userPrompt}" → AI 生成: ${item.aiGeneratedCommand} / 用户修改为: ${item.command} ${status}`
+      } else {
+        // 未修改，使用原格式
+        let line = `${index + 1}. [${timeAgo}] "${item.userPrompt}" → ${item.command} ${status}`
+
+        // 如果有输出且命令失败，附加输出摘要
+        if (item.output && item.exitCode !== 0) {
+          line += `\n   输出: ${item.output.split('\n')[0]}` // 只取第一行
+        }
+
+        return line
+      }
+    })
+    .reverse() // 从旧到新排列
+
+  return `【最近通过 pls 执行的命令】\n${lines.join('\n')}`
+}
+
+/**
+ * 计算时间差的友好显示
+ */
+function getTimeAgo(timestamp: string): string {
+  if (!timestamp) return '未知'
+
+  const now = Date.now()
+  const then = new Date(timestamp).getTime()
+  const diff = Math.floor((now - then) / 1000)
+
+  if (diff < 60) return '刚刚'
+  if (diff < 3600) return `${Math.floor(diff / 60)}分钟前`
+  if (diff < 86400) return `${Math.floor(diff / 3600)}小时前`
+  return `${Math.floor(diff / 86400)}天前`
+}
+
+/**
+ * 获取历史记录文件路径（供显示用）
+ */
+export function getHistoryFilePath(): string {
+  return HISTORY_FILE
+}

package/src/mastra-agent.ts

@@ -1,6 +1,6 @@
 import { Agent } from '@mastra/core'
 import { getConfig } from './config.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'
@@ -8,7 +8,6 @@ import { formatShellHistoryForAI, getShellHistory } from './shell-hook.js'
 /**
  * 创建 Mastra Shell Agent
  * 根据用户配置的 API Key、Base URL、Provider 和 Model
- * 使用 ai.js 中的统一提示词
  */
 export function createShellAgent() {
   const config = getConfig()
@@ -16,12 +15,12 @@ export function createShellAgent() {
   // 组合 provider/model 格式（Mastra 要求）
   const modelId = `${config.provider}/${config.model}` as `${string}/${string}`
 
-  // 构建系统提示词（使用 ai.js 中的统一函数）
+  // 构建系统提示词
   const sysinfo = formatSystemInfo()
   const plsHistory = formatHistoryForAI()
   const shellHistory = formatShellHistoryForAI()
   const shellHookEnabled = config.shellHook && getShellHistory().length > 0
-  const systemPrompt = buildSystemPrompt(sysinfo, plsHistory, shellHistory, shellHookEnabled)
+  const systemPrompt = buildCommandSystemPrompt(sysinfo, plsHistory, shellHistory, shellHookEnabled)
 
   return new Agent({
     name: 'shell-commander',

package/src/mastra-chat.ts

@@ -0,0 +1,124 @@
+import { Agent } from '@mastra/core'
+import { getConfig } from './config.js'
+import { buildChatSystemPrompt } from './prompts.js'
+import { formatSystemInfo } from './sysinfo.js'
+import { formatHistoryForAI } from './history.js'
+import { formatShellHistoryForAI, getShellHistory } from './shell-hook.js'
+import { getChatHistory, addChatMessage } from './chat-history.js'
+
+/**
+ * 创建 Mastra Chat Agent
+ */
+export function createChatAgent() {
+  const config = getConfig()
+
+  // 组合 provider/model 格式（Mastra 要求）
+  const modelId = `${config.provider}/${config.model}` as `${string}/${string}`
+
+  // 构建系统提示词
+  const sysinfo = formatSystemInfo()
+  const plsHistory = formatHistoryForAI()
+  const shellHistory = formatShellHistoryForAI()
+  const shellHookEnabled = config.shellHook && getShellHistory().length > 0
+  const systemPrompt = buildChatSystemPrompt(sysinfo, plsHistory, shellHistory, shellHookEnabled)
+
+  return new Agent({
+    name: 'chat-assistant',
+    instructions: systemPrompt,
+    model: {
+      url: config.baseUrl,
+      id: modelId,
+      apiKey: config.apiKey,
+    },
+  })
+}
+
+/**
+ * 获取完整的系统提示词（用于调试）
+ */
+export function getChatSystemPrompt(): string {
+  const config = getConfig()
+  const sysinfo = formatSystemInfo()
+  const plsHistory = formatHistoryForAI()
+  const shellHistory = formatShellHistoryForAI()
+  const shellHookEnabled = config.shellHook && getShellHistory().length > 0
+  return buildChatSystemPrompt(sysinfo, plsHistory, shellHistory, shellHookEnabled)
+}
+
+/**
+ * 使用 Mastra 进行 AI 对话（支持流式输出）
+ */
+export async function chatWithMastra(
+  prompt: string,
+  options: {
+    debug?: boolean
+    onChunk?: (chunk: string) => void
+  } = {}
+): Promise<{
+  reply: string
+  debug?: {
+    sysinfo: string
+    model: string
+    systemPrompt: string
+    chatHistory: Array<{ role: string; content: string }>
+    userPrompt: string
+  }
+}> {
+  const config = getConfig()
+  const agent = createChatAgent()
+
+  // 获取对话历史
+  const chatHistory = getChatHistory()
+
+  // 构建消息数组（将历史和新消息合并）
+  const messages: string[] = []
+
+  // 添加历史对话
+  for (const msg of chatHistory) {
+    messages.push(msg.content)
+  }
+
+  // 添加当前用户消息
+  messages.push(prompt)
+
+  let fullContent = ''
+
+  // 流式输出模式
+  if (options.onChunk) {
+    const stream = await agent.stream(messages)
+
+    for await (const chunk of stream.textStream) {
+      if (chunk) {
+        fullContent += chunk
+        options.onChunk(chunk)
+      }
+    }
+  } else {
+    // 非流式模式
+    const response = await agent.generate(messages)
+    fullContent = response.text || ''
+  }
+
+  if (!fullContent) {
+    throw new Error('AI 返回了空的响应')
+  }
+
+  // 保存对话历史
+  addChatMessage(prompt, fullContent)
+
+  // 返回结果
+  if (options.debug) {
+    return {
+      reply: fullContent,
+      debug: {
+        sysinfo: formatSystemInfo(),
+        model: config.model,
+        systemPrompt: getChatSystemPrompt(),
+        chatHistory,
+        userPrompt: prompt,
+      },
+    }
+  }
+
+  return { reply: fullContent }
+}

package/src/multi-step.ts

@@ -1,6 +1,6 @@
 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'
@@ -36,7 +36,7 @@ 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)
 }
 
 /**

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
+}