@elizaos/plugin-shell 1.2.0 → 2.0.0-alpha.10

package/dist/generated/specs/specs.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Auto-generated canonical action/provider/evaluator docs for plugin-shell.
+ * DO NOT EDIT - Generated from prompts/specs/**.
+ */
+export type ActionDoc = {
+    name: string;
+    description: string;
+    similes?: readonly string[];
+    parameters?: readonly unknown[];
+    examples?: readonly (readonly unknown[])[];
+};
+export type ProviderDoc = {
+    name: string;
+    description: string;
+    position?: number;
+    dynamic?: boolean;
+};
+export type EvaluatorDoc = {
+    name: string;
+    description: string;
+    similes?: readonly string[];
+    alwaysRun?: boolean;
+    examples?: readonly unknown[];
+};
+export declare const coreActionsSpec: {
+    readonly version: "1.0.0";
+    readonly actions: readonly [{
+        readonly name: "CLEAR_SHELL_HISTORY";
+        readonly description: "Clears the recorded history of shell commands for the current conversation";
+        readonly similes: readonly ["RESET_SHELL", "CLEAR_TERMINAL", "CLEAR_HISTORY", "RESET_HISTORY"];
+        readonly parameters: readonly [];
+    }];
+};
+export declare const allActionsSpec: {
+    readonly version: "1.0.0";
+    readonly actions: readonly [{
+        readonly name: "CLEAR_SHELL_HISTORY";
+        readonly description: "Clears the recorded history of shell commands for the current conversation";
+        readonly similes: readonly ["RESET_SHELL", "CLEAR_TERMINAL", "CLEAR_HISTORY", "RESET_HISTORY"];
+        readonly parameters: readonly [];
+    }];
+};
+export declare const coreProvidersSpec: {
+    readonly version: "1.0.0";
+    readonly providers: readonly [{
+        readonly name: "SHELL_HISTORY";
+        readonly description: "Provides recent shell command history, current working directory, and file operations within the restricted environment";
+        readonly dynamic: true;
+    }];
+};
+export declare const allProvidersSpec: {
+    readonly version: "1.0.0";
+    readonly providers: readonly [{
+        readonly name: "SHELL_HISTORY";
+        readonly description: "Provides recent shell command history, current working directory, and file operations within the restricted environment";
+        readonly dynamic: true;
+    }];
+};
+export declare const coreEvaluatorsSpec: {
+    readonly version: "1.0.0";
+    readonly evaluators: readonly [];
+};
+export declare const allEvaluatorsSpec: {
+    readonly version: "1.0.0";
+    readonly evaluators: readonly [];
+};
+export declare const coreActionDocs: readonly ActionDoc[];
+export declare const allActionDocs: readonly ActionDoc[];
+export declare const coreProviderDocs: readonly ProviderDoc[];
+export declare const allProviderDocs: readonly ProviderDoc[];
+export declare const coreEvaluatorDocs: readonly EvaluatorDoc[];
+export declare const allEvaluatorDocs: readonly EvaluatorDoc[];
+//# sourceMappingURL=specs.d.ts.map

package/dist/generated/specs/specs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"specs.d.ts","sourceRoot":"","sources":["../../../generated/specs/specs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAChC,QAAQ,CAAC,EAAE,SAAS,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;CAC9B,CAAC;AAEF,eAAO,MAAM,eAAe;;;;;;;;CAgBlB,CAAC;AACX,eAAO,MAAM,cAAc;;;;;;;;CAgBjB,CAAC;AACX,eAAO,MAAM,iBAAiB;;;;;;;CAUpB,CAAC;AACX,eAAO,MAAM,gBAAgB;;;;;;;CAUnB,CAAC;AACX,eAAO,MAAM,kBAAkB;;;CAGrB,CAAC;AACX,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AAEX,eAAO,MAAM,cAAc,EAAE,SAAS,SAAS,EAA4B,CAAC;AAC5E,eAAO,MAAM,aAAa,EAAE,SAAS,SAAS,EAA2B,CAAC;AAC1E,eAAO,MAAM,gBAAgB,EAAE,SAAS,WAAW,EACvB,CAAC;AAC7B,eAAO,MAAM,eAAe,EAAE,SAAS,WAAW,EACvB,CAAC;AAC5B,eAAO,MAAM,iBAAiB,EAAE,SAAS,YAAY,EACvB,CAAC;AAC/B,eAAO,MAAM,gBAAgB,EAAE,SAAS,YAAY,EACvB,CAAC"}

package/dist/index.browser.d.ts

@@ -0,0 +1,4 @@
+import type { Plugin } from "@elizaos/core";
+export declare const shellPlugin: Plugin;
+export default shellPlugin;
+//# sourceMappingURL=index.browser.d.ts.map

package/dist/index.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../index.browser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAiB,MAAM,EAAE,MAAM,eAAe,CAAC;AAK3D,eAAO,MAAM,WAAW,EAAE,MAQzB,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/dist/index.d.ts

@@ -1,106 +1,14 @@
-import { Service, IAgentRuntime, Action, Plugin } from '@elizaos/core';
-
-interface CommandResult {
-    success: boolean;
-    stdout: string;
-    stderr: string;
-    exitCode: number | null;
-    error?: string;
-    executedIn: string;
-}
-interface CommandHistoryEntry {
-    command: string;
-    stdout: string;
-    stderr: string;
-    exitCode: number | null;
-    timestamp: number;
-    workingDirectory: string;
-    fileOperations?: FileOperation[];
-}
-interface FileOperation {
-    type: 'create' | 'write' | 'read' | 'delete' | 'mkdir' | 'move' | 'copy';
-    target: string;
-    secondaryTarget?: string;
-}
-declare class ShellService extends Service {
-    static serviceType: string;
-    private shellConfig;
-    private currentDirectory;
-    private commandHistory;
-    private maxHistoryPerConversation;
-    constructor(runtime: IAgentRuntime);
-    static start(runtime: IAgentRuntime): Promise<ShellService>;
-    stop(): Promise<void>;
-    get capabilityDescription(): string;
-    /**
-     * Executes a shell command within the allowed directory
-     * @param command The command to execute
-     * @param conversationId Optional conversation ID for history tracking
-     * @returns The command execution result
-     */
-    executeCommand(command: string, conversationId?: string): Promise<CommandResult>;
-    /**
-     * Handles the cd command to change directory within allowed bounds
-     * @param command The cd command
-     * @returns The command result
-     */
-    private handleCdCommand;
-    /**
-     * Runs a command using cross-spawn
-     * @param command The command to run
-     * @returns The command result
-     */
-    private runCommand;
-    /**
-     * Adds a command to the history
-     */
-    private addToHistory;
-    /**
-     * Detects file operations from a command
-     */
-    private detectFileOperations;
-    /**
-     * Resolves a path relative to the current working directory
-     */
-    private resolvePath;
-    /**
-     * Gets command history for a conversation
-     */
-    getCommandHistory(conversationId: string, limit?: number): CommandHistoryEntry[];
-    /**
-     * Clears command history for a conversation
-     */
-    clearCommandHistory(conversationId: string): void;
-    /**
-     * Gets the current working directory
-     * @param conversationId Optional conversation ID to get conversation-specific directory
-     * @returns The current directory path
-     */
-    getCurrentDirectory(_conversationId?: string): string;
-    /**
-     * Gets the allowed directory
-     * @returns The allowed directory path
-     */
-    getAllowedDirectory(): string;
-}
-
-declare const executeCommand: Action;
-
-/**
- * Shell plugin environment configuration
- */
-interface ShellConfig {
-    enabled: boolean;
-    allowedDirectory: string;
-    timeout: number;
-    forbiddenCommands: string[];
-}
-/**
- * Loads and validates the shell plugin configuration
- * @returns The validated configuration
- */
-declare function loadShellConfig(): ShellConfig;
-
-declare const shellPlugin: Plugin;
-
-export { type CommandResult, type ShellConfig, ShellService, shellPlugin as default, executeCommand, loadShellConfig, shellPlugin };
+import type { Plugin } from "@elizaos/core";
+export declare const shellPlugin: Plugin;
+export default shellPlugin;
+export { clearHistory } from "./actions/clearHistory";
+export { addAllowlistEntry, analyzeShellCommand, type CommandCheckResult, type CommandResolution, DEFAULT_SAFE_BINS, EXEC_APPROVAL_DEFAULTS, type ExecAllowlistAnalysis, type ExecAllowlistEntry, type ExecAllowlistEvaluation, type ExecApprovalDecision, type ExecApprovalRequest, type ExecApprovalResult, ExecApprovalService, type ExecApprovalsAgent, type ExecApprovalsDefaults, type ExecApprovalsFile, type ExecApprovalsResolved, type ExecApprovalsSnapshot, type ExecAsk, type ExecCommandAnalysis, type ExecCommandSegment, type ExecHost, type ExecSecurity, ensureApprovals, evaluateExecAllowlist, evaluateShellAllowlist, getApprovalFilePath, getApprovalSocketPath, isSafeBinUsage, loadApprovals, matchAllowlist, maxAsk, minSecurity, normalizeApprovals, normalizeSafeBins, readApprovalsSnapshot, recordAllowlistUse, requiresExecApproval, resolveApprovals, resolveApprovalsFromFile, resolveCommandFromArgv, resolveCommandResolution, resolveSafeBins, saveApprovals, } from "./approvals";
+export { terminalUsageProvider } from "./providers/terminalUsage";
+export { shellHistoryProvider } from "./providers/shellHistoryProvider";
+export { addSession, appendOutput, clearFinished, createSessionSlug, deleteSession, drainSession, getFinishedSession, getSession, listFinishedSessions, listRunningSessions, markBackgrounded, markExited, resetProcessRegistryForTests, setJobTtlMs, tail, trimWithCap, } from "./services/processRegistry";
+export { ShellService } from "./services/shellService";
+export type { CommandHistoryEntry, CommandResult, ExecResult, ExecuteOptions, FileOperation, FileOperationType, FinishedSession, ProcessAction, ProcessActionParams, ProcessSession, ProcessStatus, PtyExitEvent, PtyHandle, PtyListener, PtySpawn, SessionStdin, ShellConfig, } from "./types";
+export { DEFAULT_FORBIDDEN_COMMANDS, extractBaseCommand, isForbiddenCommand, isSafeCommand, loadShellConfig, validatePath, } from "./utils";
+export { BRACKETED_PASTE_END, BRACKETED_PASTE_START, buildCursorPositionResponse, encodeKeySequence, encodePaste, type KeyEncodingRequest, type KeyEncodingResult, stripDsrRequests, } from "./utils/ptyKeys";
+export { chunkString, clampNumber, coerceEnv, deriveSessionName, formatDuration, formatSpawnError, getShellConfig, killProcessTree, killSession, pad, readEnvInt, resolveWorkdir, type SpawnFallback, type SpawnWithFallbackResult, sanitizeBinaryOutput, sliceLogLines, sliceUtf16Safe, spawnWithFallback, truncateMiddle, } from "./utils/shellUtils";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAO5C,eAAO,MAAM,WAAW,EAAE,MAOzB,CAAC;AAEF,eAAe,WAAW,CAAC;AAG3B,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAGtD,OAAO,EACN,iBAAiB,EACjB,mBAAmB,EACnB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,iBAAiB,EACjB,sBAAsB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,mBAAmB,EACnB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,eAAe,EACf,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,cAAc,EACd,aAAa,EACb,cAAc,EACd,MAAM,EACN,WAAW,EACX,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,wBAAwB,EACxB,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,EACf,aAAa,GACb,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EACN,UAAU,EACV,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,UAAU,EACV,4BAA4B,EAC5B,WAAW,EACX,IAAI,EACJ,WAAW,GACX,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGvD,YAAY,EACX,mBAAmB,EACnB,aAAa,EACb,UAAU,EACV,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,YAAY,EACZ,SAAS,EACT,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,WAAW,GACX,MAAM,SAAS,CAAC;AAGjB,OAAO,EACN,0BAA0B,EAC1B,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,eAAe,EACf,YAAY,GACZ,MAAM,SAAS,CAAC;AACjB,OAAO,EACN,mBAAmB,EACnB,qBAAqB,EACrB,2BAA2B,EAC3B,iBAAiB,EACjB,WAAW,EACX,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,gBAAgB,GAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACN,WAAW,EACX,WAAW,EACX,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,WAAW,EACX,GAAG,EACH,UAAU,EACV,cAAc,EACd,KAAK,aAAa,EAClB,KAAK,uBAAuB,EAC5B,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,cAAc,GACd,MAAM,oBAAoB,CAAC"}