@yivan-lab/pretty-please 1.0.0 → 1.2.0

package/dist/src/history.d.ts

@@ -1,20 +1,34 @@
+/**
+ * 历史记录项
+ */
+export interface HistoryRecord {
+    userPrompt: string;
+    command: string;
+    aiGeneratedCommand?: string;
+    userModified?: boolean;
+    executed: boolean;
+    exitCode: number | null;
+    output?: string;
+    reason?: 'builtin' | string;
+    timestamp?: string;
+}
 /**
  * 读取历史记录
  */
-export function getHistory(): any;
+export declare function getHistory(): HistoryRecord[];
 /**
  * 添加一条历史记录
  */
-export function addHistory(record: any): void;
+export declare function addHistory(record: HistoryRecord): void;
 /**
  * 清空历史记录
  */
-export function clearHistory(): void;
+export declare function clearHistory(): void;
 /**
  * 格式化历史记录供 AI 使用
  */
-export function formatHistoryForAI(): string;
+export declare function formatHistoryForAI(): string;
 /**
  * 获取历史记录文件路径（供显示用）
  */
-export function getHistoryFilePath(): string;
+export declare function getHistoryFilePath(): string;

package/dist/src/history.js

@@ -1,6 +1,7 @@
 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;
@@ -40,6 +41,7 @@ function saveHistory(history) {
  * 添加一条历史记录
  */
 export function addHistory(record) {
+    const config = getConfig();
     const history = getHistory();
     // 截断输出
     if (record.output && record.output.length > MAX_OUTPUT_LENGTH) {
@@ -49,9 +51,10 @@ export function addHistory(record) {
     record.timestamp = new Date().toISOString();
     // 添加到开头
     history.unshift(record);
-    // 保留最近 N 条
-    if (history.length > MAX_HISTORY) {
-        history.length = MAX_HISTORY;
+    // 保留最近 N 条（从配置读取）
+    const maxHistory = config.commandHistoryLimit || MAX_HISTORY;
+    if (history.length > maxHistory) {
+        history.length = maxHistory;
     }
     saveHistory(history);
 }
@@ -69,8 +72,9 @@ export function formatHistoryForAI() {
     if (history.length === 0) {
         return '';
     }
-    const lines = history.map((item, index) => {
-        const timeAgo = getTimeAgo(item.timestamp);
+    const lines = history
+        .map((item, index) => {
+        const timeAgo = getTimeAgo(item.timestamp || '');
         let status;
         if (item.executed) {
             status = item.exitCode === 0 ? '✓' : `✗ 退出码:${item.exitCode}`;
@@ -81,19 +85,30 @@ export function formatHistoryForAI() {
         else {
             status = '(用户取消执行)';
         }
-        let line = `${index + 1}. [${timeAgo}] "${item.userPrompt}" → ${item.command} ${status}`;
-        // 如果有输出且命令失败，附加输出摘要
-        if (item.output && item.exitCode !== 0) {
-            line += `\n   输出: ${item.output.split('\n')[0]}`; // 只取第一行
+        // 检查是否用户修改了命令
+        if (item.userModified && item.aiGeneratedCommand) {
+            // 用户修改了命令
+            return `${index + 1}. [${timeAgo}] "${item.userPrompt}" → AI 生成: ${item.aiGeneratedCommand} / 用户修改为: ${item.command} ${status}`;
         }
-        return line;
-    }).reverse(); // 从旧到新排列
+        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) {
+    if (!timestamp)
+        return '未知';
     const now = Date.now();
     const then = new Date(timestamp).getTime();
     const diff = Math.floor((now - then) / 1000);

package/dist/src/mastra-agent.d.ts

@@ -2,6 +2,5 @@ import { Agent } from '@mastra/core';
 /**
  * 创建 Mastra Shell Agent
  * 根据用户配置的 API Key、Base URL、Provider 和 Model
- * 使用 ai.js 中的统一提示词
  */
 export declare function createShellAgent(): Agent<"shell-commander", Record<string, import("@mastra/core").ToolAction<any, any, any, any, import("@mastra/core").ToolExecutionContext<any, any, any>>>, Record<string, import("@mastra/core").Metric>>;

package/dist/src/mastra-agent.js

@@ -1,24 +1,23 @@
 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';
 /**
  * 创建 Mastra Shell Agent
  * 根据用户配置的 API Key、Base URL、Provider 和 Model
- * 使用 ai.js 中的统一提示词
  */
 export function createShellAgent() {
     const config = getConfig();
     // 组合 provider/model 格式（Mastra 要求）
     const modelId = `${config.provider}/${config.model}`;
-    // 构建系统提示词（使用 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',
         instructions: systemPrompt,

package/dist/src/mastra-chat.d.ts

@@ -0,0 +1,28 @@
+import { Agent } from '@mastra/core';
+/**
+ * 创建 Mastra Chat Agent
+ */
+export declare function createChatAgent(): Agent<"chat-assistant", Record<string, import("@mastra/core").ToolAction<any, any, any, any, import("@mastra/core").ToolExecutionContext<any, any, any>>>, Record<string, import("@mastra/core").Metric>>;
+/**
+ * 获取完整的系统提示词（用于调试）
+ */
+export declare function getChatSystemPrompt(): string;
+/**
+ * 使用 Mastra 进行 AI 对话（支持流式输出）
+ */
+export declare 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;
+    };
+}>;

package/dist/src/mastra-chat.js

@@ -0,0 +1,93 @@
+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}`;
+    // 构建系统提示词
+    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() {
+    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, options = {}) {
+    const config = getConfig();
+    const agent = createChatAgent();
+    // 获取对话历史
+    const chatHistory = getChatHistory();
+    // 构建消息数组（将历史和新消息合并）
+    const messages = [];
+    // 添加历史对话
+    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/dist/src/multi-step.d.ts

@@ -1,21 +1,24 @@
 import { z } from 'zod';
+import { type RemoteSysInfo } from './config.js';
+import { type RemoteShellHistoryItem } from './remote-history.js';
 /**
  * 多步骤命令的 Zod Schema
+ * 注意：optional 字段使用 .default() 是为了绕过 Mastra 0.24.8 对 optional 字段的验证 bug
  */
 export declare const CommandStepSchema: z.ZodObject<{
     command: z.ZodString;
-    continue: z.ZodOptional<z.ZodBoolean>;
-    reasoning: z.ZodOptional<z.ZodString>;
-    nextStepHint: z.ZodOptional<z.ZodString>;
+    continue: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    reasoning: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    nextStepHint: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     command: string;
-    continue?: boolean | undefined;
-    reasoning?: string | undefined;
-    nextStepHint?: string | undefined;
+    reasoning: string;
+    continue: boolean;
+    nextStepHint: string;
 }, {
     command: string;
-    continue?: boolean | undefined;
     reasoning?: string | undefined;
+    continue?: boolean | undefined;
     nextStepHint?: string | undefined;
 }>;
 export type CommandStep = z.infer<typeof CommandStepSchema>;
@@ -26,15 +29,28 @@ export interface ExecutedStep extends CommandStep {
     exitCode: number;
     output: string;
 }
+/**
+ * 远程执行上下文
+ */
+export interface RemoteContext {
+    name: string;
+    sysInfo: RemoteSysInfo;
+    shellHistory: RemoteShellHistoryItem[];
+}
 /**
  * 生成系统上下文信息（供 Mastra 使用）
  */
 export declare function getFullSystemPrompt(): string;
+/**
+ * 生成远程系统上下文信息
+ */
+export declare function getRemoteFullSystemPrompt(remoteContext: RemoteContext): string;
 /**
  * 使用 Mastra 生成多步骤命令
  */
 export declare function generateMultiStepCommand(userPrompt: string, previousSteps?: ExecutedStep[], options?: {
     debug?: boolean;
+    remoteContext?: RemoteContext;
 }): Promise<{
     stepData: CommandStep;
     debugInfo?: any;

package/dist/src/multi-step.js

@@ -1,18 +1,21 @@
 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 { formatRemoteHistoryForAI, formatRemoteShellHistoryForAI } 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(''),
 });
 /**
  * 生成系统上下文信息（供 Mastra 使用）
@@ -23,14 +26,30 @@ export function getFullSystemPrompt() {
     const plsHistory = formatHistoryForAI();
     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) {
+    // 格式化远程系统信息
+    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);
 }
 /**
  * 使用 Mastra 生成多步骤命令
  */
 export async function generateMultiStepCommand(userPrompt, previousSteps = [], options = {}) {
     const agent = createShellAgent();
-    const fullSystemPrompt = getFullSystemPrompt();
+    // 根据是否有远程上下文选择不同的系统提示词
+    const fullSystemPrompt = options.remoteContext
+        ? getRemoteFullSystemPrompt(options.remoteContext)
+        : getFullSystemPrompt();
     // 构建消息数组（string[] 格式）
     const messages = [userPrompt];
     // 添加之前步骤的执行结果
@@ -60,6 +79,10 @@ export async function generateMultiStepCommand(userPrompt, previousSteps = [], o
                 userPrompt,
                 previousStepsCount: previousSteps.length,
                 response: stepData,
+                remoteContext: options.remoteContext ? {
+                    name: options.remoteContext.name,
+                    sysInfo: options.remoteContext.sysInfo,
+                } : undefined,
             },
         };
     }

package/dist/src/prompts.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 统一管理所有 AI 系统提示词
+ */
+/**
+ * 构建命令生成模式的系统提示词
+ */
+export declare function buildCommandSystemPrompt(sysinfo: string, plsHistory: string, shellHistory: string, shellHookEnabled: boolean): string;
+/**
+ * 构建 Chat 对话模式的系统提示词
+ */
+export declare function buildChatSystemPrompt(sysinfo: string, plsHistory: string, shellHistory: string, shellHookEnabled: boolean): string;

package/dist/src/prompts.js

@@ -0,0 +1,140 @@
+/**
+ * 统一管理所有 AI 系统提示词
+ */
+/**
+ * 构建命令生成模式的系统提示词
+ */
+export function buildCommandSystemPrompt(sysinfo, plsHistory, shellHistory, shellHookEnabled) {
+    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, plsHistory, shellHistory, shellHookEnabled) {
+    let prompt = `你是一个命令行专家助手，帮助用户理解和使用命令行工具。
+
+【你的能力】
+- 解释命令的含义、参数、用法
+- 分析命令的执行效果和潜在风险
+- 回答命令行、Shell、系统管理相关问题
+- 根据用户需求推荐合适的命令并解释
+
+【回答要求】
+- 简洁清晰，避免冗余
+- 危险操作要明确警告
+- 适当给出示例命令
+- 结合用户的系统环境给出针对性建议
+
+【用户系统信息】
+${sysinfo}`;
+    // 根据是否启用 shell hook 决定展示哪个历史
+    if (shellHookEnabled && shellHistory) {
+        prompt += `\n\n${shellHistory}`;
+    }
+    else if (plsHistory) {
+        prompt += `\n\n${plsHistory}`;
+    }
+    return prompt;
+}

package/dist/src/remote-history.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 远程服务器历史管理模块
+ * 管理每个远程服务器的命令历史
+ */
+/**
+ * 远程命令历史记录
+ */
+export interface RemoteHistoryRecord {
+    userPrompt: string;
+    command: string;
+    aiGeneratedCommand?: string;
+    userModified?: boolean;
+    executed: boolean;
+    exitCode: number | null;
+    output: string;
+    timestamp: string;
+    reason?: string;
+}
+/**
+ * Shell 历史记录项
+ */
+export interface RemoteShellHistoryItem {
+    cmd: string;
+    exit: number;
+    time: string;
+}
+/**
+ * 获取远程服务器命令历史
+ */
+export declare function getRemoteHistory(name: string): RemoteHistoryRecord[];
+/**
+ * 添加远程命令历史记录
+ */
+export declare function addRemoteHistory(name: string, record: Omit<RemoteHistoryRecord, 'timestamp'>): void;
+/**
+ * 清空远程命令历史
+ */
+export declare function clearRemoteHistory(name: string): void;
+/**
+ * 格式化远程命令历史供 AI 使用
+ */
+export declare function formatRemoteHistoryForAI(name: string): string;
+/**
+ * 显示远程命令历史
+ */
+export declare function displayRemoteHistory(name: string): void;
+/**
+ * 从远程服务器读取 shell 历史
+ * 读取远程 ~/.please/shell_history.jsonl
+ */
+export declare function fetchRemoteShellHistory(name: string): Promise<RemoteShellHistoryItem[]>;
+/**
+ * 格式化远程 shell 历史供 AI 使用
+ */
+export declare function formatRemoteShellHistoryForAI(items: RemoteShellHistoryItem[]): string;
+/**
+ * 显示远程 shell 历史
+ */
+export declare function displayRemoteShellHistory(name: string): Promise<void>;
+/**
+ * 清空远程 shell 历史
+ */
+export declare function clearRemoteShellHistory(name: string): Promise<void>;