shortcutxl 0.2.12 → 0.2.13

package/agent-docs/examples/extensions/send-user-message.ts

@@ -1,97 +1,97 @@
-/**
- * Send User Message Example
- *
- * Demonstrates shortcut.sendUserMessage() for sending user messages from extensions.
- * Unlike shortcut.sendMessage() which sends custom messages, sendUserMessage() sends
- * actual user messages that appear in the conversation as if typed by the user.
- *
- * Usage:
- *   /ask What is 2+2?     - Sends a user message (always triggers a turn)
- *   /steer Focus on X     - Sends while streaming with steer delivery
- *   /followup And then?   - Sends while streaming with followUp delivery
- */
-
-import type { ExtensionAPI } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  // Simple command that sends a user message
-  shortcut.registerCommand('ask', {
-    description: 'Send a user message to the agent',
-    handler: async (args, ctx) => {
-      if (!args.trim()) {
-        ctx.ui.notify('Usage: /ask <message>', 'warning');
-        return;
-      }
-
-      // sendUserMessage always triggers a turn when not streaming
-      // If streaming, it will throw (no deliverAs specified)
-      if (!ctx.isIdle()) {
-        ctx.ui.notify('Agent is busy. Use /steer or /followup instead.', 'warning');
-        return;
-      }
-
-      shortcut.sendUserMessage(args);
-    }
-  });
-
-  // Command that steers the agent mid-conversation
-  shortcut.registerCommand('steer', {
-    description: 'Send a steering message (interrupts current processing)',
-    handler: async (args, ctx) => {
-      if (!args.trim()) {
-        ctx.ui.notify('Usage: /steer <message>', 'warning');
-        return;
-      }
-
-      if (ctx.isIdle()) {
-        // Not streaming, just send normally
-        shortcut.sendUserMessage(args);
-      } else {
-        // Streaming - use steer to interrupt
-        shortcut.sendUserMessage(args, { deliverAs: 'steer' });
-      }
-    }
-  });
-
-  // Command that queues a follow-up message
-  shortcut.registerCommand('followup', {
-    description: 'Queue a follow-up message (waits for current processing)',
-    handler: async (args, ctx) => {
-      if (!args.trim()) {
-        ctx.ui.notify('Usage: /followup <message>', 'warning');
-        return;
-      }
-
-      if (ctx.isIdle()) {
-        // Not streaming, just send normally
-        shortcut.sendUserMessage(args);
-      } else {
-        // Streaming - queue as follow-up
-        shortcut.sendUserMessage(args, { deliverAs: 'followUp' });
-        ctx.ui.notify('Follow-up queued', 'info');
-      }
-    }
-  });
-
-  // Example with content array (text + images would go here)
-  shortcut.registerCommand('askwith', {
-    description: 'Send a user message with structured content',
-    handler: async (args, ctx) => {
-      if (!args.trim()) {
-        ctx.ui.notify('Usage: /askwith <message>', 'warning');
-        return;
-      }
-
-      if (!ctx.isIdle()) {
-        ctx.ui.notify('Agent is busy', 'warning');
-        return;
-      }
-
-      // sendUserMessage accepts string or (TextContent | ImageContent)[]
-      shortcut.sendUserMessage([
-        { type: 'text', text: `User request: ${args}` },
-        { type: 'text', text: 'Please respond concisely.' }
-      ]);
-    }
-  });
-}
+/**
+ * Send User Message Example
+ *
+ * Demonstrates shortcut.sendUserMessage() for sending user messages from extensions.
+ * Unlike shortcut.sendMessage() which sends custom messages, sendUserMessage() sends
+ * actual user messages that appear in the conversation as if typed by the user.
+ *
+ * Usage:
+ *   /ask What is 2+2?     - Sends a user message (always triggers a turn)
+ *   /steer Focus on X     - Sends while streaming with steer delivery
+ *   /followup And then?   - Sends while streaming with followUp delivery
+ */
+
+import type { ExtensionAPI } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  // Simple command that sends a user message
+  shortcut.registerCommand('ask', {
+    description: 'Send a user message to the agent',
+    handler: async (args, ctx) => {
+      if (!args.trim()) {
+        ctx.ui.notify('Usage: /ask <message>', 'warning');
+        return;
+      }
+
+      // sendUserMessage always triggers a turn when not streaming
+      // If streaming, it will throw (no deliverAs specified)
+      if (!ctx.isIdle()) {
+        ctx.ui.notify('Agent is busy. Use /steer or /followup instead.', 'warning');
+        return;
+      }
+
+      shortcut.sendUserMessage(args);
+    }
+  });
+
+  // Command that steers the agent mid-conversation
+  shortcut.registerCommand('steer', {
+    description: 'Send a steering message (interrupts current processing)',
+    handler: async (args, ctx) => {
+      if (!args.trim()) {
+        ctx.ui.notify('Usage: /steer <message>', 'warning');
+        return;
+      }
+
+      if (ctx.isIdle()) {
+        // Not streaming, just send normally
+        shortcut.sendUserMessage(args);
+      } else {
+        // Streaming - use steer to interrupt
+        shortcut.sendUserMessage(args, { deliverAs: 'steer' });
+      }
+    }
+  });
+
+  // Command that queues a follow-up message
+  shortcut.registerCommand('followup', {
+    description: 'Queue a follow-up message (waits for current processing)',
+    handler: async (args, ctx) => {
+      if (!args.trim()) {
+        ctx.ui.notify('Usage: /followup <message>', 'warning');
+        return;
+      }
+
+      if (ctx.isIdle()) {
+        // Not streaming, just send normally
+        shortcut.sendUserMessage(args);
+      } else {
+        // Streaming - queue as follow-up
+        shortcut.sendUserMessage(args, { deliverAs: 'followUp' });
+        ctx.ui.notify('Follow-up queued', 'info');
+      }
+    }
+  });
+
+  // Example with content array (text + images would go here)
+  shortcut.registerCommand('askwith', {
+    description: 'Send a user message with structured content',
+    handler: async (args, ctx) => {
+      if (!args.trim()) {
+        ctx.ui.notify('Usage: /askwith <message>', 'warning');
+        return;
+      }
+
+      if (!ctx.isIdle()) {
+        ctx.ui.notify('Agent is busy', 'warning');
+        return;
+      }
+
+      // sendUserMessage accepts string or (TextContent | ImageContent)[]
+      shortcut.sendUserMessage([
+        { type: 'text', text: `User request: ${args}` },
+        { type: 'text', text: 'Please respond concisely.' }
+      ]);
+    }
+  });
+}

package/agent-docs/examples/extensions/session-name.ts

@@ -1,27 +1,27 @@
-/**
- * Session naming example.
- *
- * Shows setSessionName/getSessionName to give sessions friendly names
- * that appear in the session selector instead of the first message.
- *
- * Usage: /session-name [name] - set or show session name
- */
-
-import type { ExtensionAPI } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  shortcut.registerCommand('session-name', {
-    description: 'Set or show session name (usage: /session-name [new name])',
-    handler: async (args, ctx) => {
-      const name = args.trim();
-
-      if (name) {
-        shortcut.setSessionName(name);
-        ctx.ui.notify(`Session named: ${name}`, 'info');
-      } else {
-        const current = shortcut.getSessionName();
-        ctx.ui.notify(current ? `Session: ${current}` : 'No session name set', 'info');
-      }
-    }
-  });
-}
+/**
+ * Session naming example.
+ *
+ * Shows setSessionName/getSessionName to give sessions friendly names
+ * that appear in the session selector instead of the first message.
+ *
+ * Usage: /session-name [name] - set or show session name
+ */
+
+import type { ExtensionAPI } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  shortcut.registerCommand('session-name', {
+    description: 'Set or show session name (usage: /session-name [new name])',
+    handler: async (args, ctx) => {
+      const name = args.trim();
+
+      if (name) {
+        shortcut.setSessionName(name);
+        ctx.ui.notify(`Session named: ${name}`, 'info');
+      } else {
+        const current = shortcut.getSessionName();
+        ctx.ui.notify(current ? `Session: ${current}` : 'No session name set', 'info');
+      }
+    }
+  });
+}

package/agent-docs/examples/extensions/shutdown-command.ts

@@ -1,69 +1,69 @@
-/**
- * Shutdown Command Extension
- *
- * Adds a /quit command that allows extensions to trigger clean shutdown.
- * Demonstrates how extensions can use ctx.shutdown() to exit shortcut cleanly.
- */
-
-import { Type } from '@sinclair/typebox';
-import type { ExtensionAPI } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  // Register a /quit command that cleanly exits shortcut
-  shortcut.registerCommand('quit', {
-    description: 'Exit shortcut cleanly',
-    handler: async (_args, ctx) => {
-      ctx.shutdown();
-    }
-  });
-
-  // You can also create a tool that shuts down after completing work
-  shortcut.registerTool({
-    name: 'finish_and_exit',
-    label: 'Finish and Exit',
-    description: 'Complete a task and exit shortcut',
-    parameters: Type.Object({}),
-    async execute(_toolCallId, _params, _signal, _onUpdate, ctx) {
-      // Do any final work here...
-      // Request graceful shutdown (deferred until agent is idle)
-      ctx.shutdown();
-
-      // This return is sent to the LLM before shutdown occurs
-      return {
-        content: [{ type: 'text', text: 'Shutdown requested. Exiting after this response.' }],
-        details: {}
-      };
-    }
-  });
-
-  // You could also create a more complex tool with parameters
-  shortcut.registerTool({
-    name: 'deploy_and_exit',
-    label: 'Deploy and Exit',
-    description: 'Deploy the application and exit shortcut',
-    parameters: Type.Object({
-      environment: Type.String({ description: 'Target environment (e.g., production, staging)' })
-    }),
-    async execute(_toolCallId, params, _signal, onUpdate, ctx) {
-      onUpdate?.({
-        content: [{ type: 'text', text: `Deploying to ${params.environment}...` }],
-        details: {}
-      });
-
-      // Example deployment logic
-      // const result = await shortcut.exec("npm", ["run", "deploy", params.environment], { signal });
-
-      // On success, request graceful shutdown
-      onUpdate?.({
-        content: [{ type: 'text', text: 'Deployment complete, exiting...' }],
-        details: {}
-      });
-      ctx.shutdown();
-
-      return {
-        content: [{ type: 'text', text: 'Done! Shutdown requested.' }],
-        details: { environment: params.environment }
-      };
-    }
-  });
-}
+/**
+ * Shutdown Command Extension
+ *
+ * Adds a /quit command that allows extensions to trigger clean shutdown.
+ * Demonstrates how extensions can use ctx.shutdown() to exit shortcut cleanly.
+ */
+
+import { Type } from '@sinclair/typebox';
+import type { ExtensionAPI } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  // Register a /quit command that cleanly exits shortcut
+  shortcut.registerCommand('quit', {
+    description: 'Exit shortcut cleanly',
+    handler: async (_args, ctx) => {
+      ctx.shutdown();
+    }
+  });
+
+  // You can also create a tool that shuts down after completing work
+  shortcut.registerTool({
+    name: 'finish_and_exit',
+    label: 'Finish and Exit',
+    description: 'Complete a task and exit shortcut',
+    parameters: Type.Object({}),
+    async execute(_toolCallId, _params, _signal, _onUpdate, ctx) {
+      // Do any final work here...
+      // Request graceful shutdown (deferred until agent is idle)
+      ctx.shutdown();
+
+      // This return is sent to the LLM before shutdown occurs
+      return {
+        content: [{ type: 'text', text: 'Shutdown requested. Exiting after this response.' }],
+        details: {}
+      };
+    }
+  });
+
+  // You could also create a more complex tool with parameters
+  shortcut.registerTool({
+    name: 'deploy_and_exit',
+    label: 'Deploy and Exit',
+    description: 'Deploy the application and exit shortcut',
+    parameters: Type.Object({
+      environment: Type.String({ description: 'Target environment (e.g., production, staging)' })
+    }),
+    async execute(_toolCallId, params, _signal, onUpdate, ctx) {
+      onUpdate?.({
+        content: [{ type: 'text', text: `Deploying to ${params.environment}...` }],
+        details: {}
+      });
+
+      // Example deployment logic
+      // const result = await shortcut.exec("npm", ["run", "deploy", params.environment], { signal });
+
+      // On success, request graceful shutdown
+      onUpdate?.({
+        content: [{ type: 'text', text: 'Deployment complete, exiting...' }],
+        details: {}
+      });
+      ctx.shutdown();
+
+      return {
+        content: [{ type: 'text', text: 'Done! Shutdown requested.' }],
+        details: { environment: params.environment }
+      };
+    }
+  });
+}