shortcutxl 0.2.12 → 0.2.13

package/agent-docs/examples/extensions/handoff.ts

@@ -1,155 +1,155 @@
-/**
- * Handoff extension - transfer context to a new focused session
- *
- * Instead of compacting (which is lossy), handoff extracts what matters
- * for your next task and creates a new session with a generated prompt.
- *
- * Usage:
- *   /handoff now implement this for teams as well
- *   /handoff execute phase one of the plan
- *   /handoff check other places that need this fix
- *
- * The generated prompt appears as a draft in the editor for review/editing.
- */
-
-import type { ExtensionAPI, SessionEntry } from 'shortcutxl';
-import {
-  BorderedLoader,
-  complete,
-  convertToLlm,
-  serializeConversation,
-  type Message
-} from 'shortcutxl';
-
-const SYSTEM_PROMPT = `You are a context transfer assistant. Given a conversation history and the user's goal for a new thread, generate a focused prompt that:
-
-1. Summarizes relevant context from the conversation (decisions made, approaches taken, key findings)
-2. Lists any relevant files that were discussed or modified
-3. Clearly states the next task based on the user's goal
-4. Is self-contained - the new thread should be able to proceed without the old conversation
-
-Format your response as a prompt the user can send to start the new thread. Be concise but include all necessary context. Do not include any preamble like "Here's the prompt" - just output the prompt itself.
-
-Example output format:
-## Context
-We've been working on X. Key decisions:
-- Decision 1
-- Decision 2
-
-Files involved:
-- path/to/file1.ts
-- path/to/file2.ts
-
-## Task
-[Clear description of what to do next based on user's goal]`;
-
-export default function (shortcut: ExtensionAPI) {
-  shortcut.registerCommand('handoff', {
-    description: 'Transfer context to a new focused session',
-    handler: async (args, ctx) => {
-      if (!ctx.hasUI) {
-        ctx.ui.notify('handoff requires interactive mode', 'error');
-        return;
-      }
-
-      if (!ctx.model) {
-        ctx.ui.notify('No model selected', 'error');
-        return;
-      }
-
-      const goal = args.trim();
-      if (!goal) {
-        ctx.ui.notify('Usage: /handoff <goal for new thread>', 'error');
-        return;
-      }
-
-      // Gather conversation context from current branch
-      const branch = ctx.sessionManager.getBranch();
-      const messages = branch
-        .filter((entry): entry is SessionEntry & { type: 'message' } => entry.type === 'message')
-        .map((entry) => entry.message);
-
-      if (messages.length === 0) {
-        ctx.ui.notify('No conversation to hand off', 'error');
-        return;
-      }
-
-      // Convert to LLM format and serialize
-      const llmMessages = convertToLlm(messages);
-      const conversationText = serializeConversation(llmMessages);
-      const currentSessionFile = ctx.sessionManager.getSessionFile();
-
-      // Generate the handoff prompt with loader UI
-      const result = await ctx.ui.custom<string | null>((tui, theme, _kb, done) => {
-        const loader = new BorderedLoader(tui, theme, `Generating handoff prompt...`);
-        loader.onAbort = () => done(null);
-
-        const doGenerate = async () => {
-          const apiKey = await ctx.modelRegistry.getApiKey(ctx.model!);
-
-          const userMessage: Message = {
-            role: 'user',
-            content: [
-              {
-                type: 'text',
-                text: `## Conversation History\n\n${conversationText}\n\n## User's Goal for New Thread\n\n${goal}`
-              }
-            ],
-            timestamp: Date.now()
-          };
-
-          const response = await complete(
-            ctx.model!,
-            { systemPrompt: SYSTEM_PROMPT, messages: [userMessage] },
-            { apiKey, signal: loader.signal }
-          );
-
-          if (response.stopReason === 'aborted') {
-            return null;
-          }
-
-          return response.content
-            .filter((c): c is { type: 'text'; text: string } => c.type === 'text')
-            .map((c) => c.text)
-            .join('\n');
-        };
-
-        doGenerate()
-          .then(done)
-          .catch((err) => {
-            console.error('Handoff generation failed:', err);
-            done(null);
-          });
-
-        return loader;
-      });
-
-      if (result === null) {
-        ctx.ui.notify('Cancelled', 'info');
-        return;
-      }
-
-      // Let user edit the generated prompt
-      const editedPrompt = await ctx.ui.editor('Edit handoff prompt', result);
-
-      if (editedPrompt === undefined) {
-        ctx.ui.notify('Cancelled', 'info');
-        return;
-      }
-
-      // Create new session with parent tracking
-      const newSessionResult = await ctx.newSession({
-        parentSession: currentSessionFile
-      });
-
-      if (newSessionResult.cancelled) {
-        ctx.ui.notify('New session cancelled', 'info');
-        return;
-      }
-
-      // Set the edited prompt in the main editor for submission
-      ctx.ui.setEditorText(editedPrompt);
-      ctx.ui.notify('Handoff ready. Submit when ready.', 'info');
-    }
-  });
-}
+/**
+ * Handoff extension - transfer context to a new focused session
+ *
+ * Instead of compacting (which is lossy), handoff extracts what matters
+ * for your next task and creates a new session with a generated prompt.
+ *
+ * Usage:
+ *   /handoff now implement this for teams as well
+ *   /handoff execute phase one of the plan
+ *   /handoff check other places that need this fix
+ *
+ * The generated prompt appears as a draft in the editor for review/editing.
+ */
+
+import type { ExtensionAPI, SessionEntry } from 'shortcutxl';
+import {
+  BorderedLoader,
+  complete,
+  convertToLlm,
+  serializeConversation,
+  type Message
+} from 'shortcutxl';
+
+const SYSTEM_PROMPT = `You are a context transfer assistant. Given a conversation history and the user's goal for a new thread, generate a focused prompt that:
+
+1. Summarizes relevant context from the conversation (decisions made, approaches taken, key findings)
+2. Lists any relevant files that were discussed or modified
+3. Clearly states the next task based on the user's goal
+4. Is self-contained - the new thread should be able to proceed without the old conversation
+
+Format your response as a prompt the user can send to start the new thread. Be concise but include all necessary context. Do not include any preamble like "Here's the prompt" - just output the prompt itself.
+
+Example output format:
+## Context
+We've been working on X. Key decisions:
+- Decision 1
+- Decision 2
+
+Files involved:
+- path/to/file1.ts
+- path/to/file2.ts
+
+## Task
+[Clear description of what to do next based on user's goal]`;
+
+export default function (shortcut: ExtensionAPI) {
+  shortcut.registerCommand('handoff', {
+    description: 'Transfer context to a new focused session',
+    handler: async (args, ctx) => {
+      if (!ctx.hasUI) {
+        ctx.ui.notify('handoff requires interactive mode', 'error');
+        return;
+      }
+
+      if (!ctx.model) {
+        ctx.ui.notify('No model selected', 'error');
+        return;
+      }
+
+      const goal = args.trim();
+      if (!goal) {
+        ctx.ui.notify('Usage: /handoff <goal for new thread>', 'error');
+        return;
+      }
+
+      // Gather conversation context from current branch
+      const branch = ctx.sessionManager.getBranch();
+      const messages = branch
+        .filter((entry): entry is SessionEntry & { type: 'message' } => entry.type === 'message')
+        .map((entry) => entry.message);
+
+      if (messages.length === 0) {
+        ctx.ui.notify('No conversation to hand off', 'error');
+        return;
+      }
+
+      // Convert to LLM format and serialize
+      const llmMessages = convertToLlm(messages);
+      const conversationText = serializeConversation(llmMessages);
+      const currentSessionFile = ctx.sessionManager.getSessionFile();
+
+      // Generate the handoff prompt with loader UI
+      const result = await ctx.ui.custom<string | null>((tui, theme, _kb, done) => {
+        const loader = new BorderedLoader(tui, theme, `Generating handoff prompt...`);
+        loader.onAbort = () => done(null);
+
+        const doGenerate = async () => {
+          const apiKey = await ctx.modelRegistry.getApiKey(ctx.model!);
+
+          const userMessage: Message = {
+            role: 'user',
+            content: [
+              {
+                type: 'text',
+                text: `## Conversation History\n\n${conversationText}\n\n## User's Goal for New Thread\n\n${goal}`
+              }
+            ],
+            timestamp: Date.now()
+          };
+
+          const response = await complete(
+            ctx.model!,
+            { systemPrompt: SYSTEM_PROMPT, messages: [userMessage] },
+            { apiKey, signal: loader.signal }
+          );
+
+          if (response.stopReason === 'aborted') {
+            return null;
+          }
+
+          return response.content
+            .filter((c): c is { type: 'text'; text: string } => c.type === 'text')
+            .map((c) => c.text)
+            .join('\n');
+        };
+
+        doGenerate()
+          .then(done)
+          .catch((err) => {
+            console.error('Handoff generation failed:', err);
+            done(null);
+          });
+
+        return loader;
+      });
+
+      if (result === null) {
+        ctx.ui.notify('Cancelled', 'info');
+        return;
+      }
+
+      // Let user edit the generated prompt
+      const editedPrompt = await ctx.ui.editor('Edit handoff prompt', result);
+
+      if (editedPrompt === undefined) {
+        ctx.ui.notify('Cancelled', 'info');
+        return;
+      }
+
+      // Create new session with parent tracking
+      const newSessionResult = await ctx.newSession({
+        parentSession: currentSessionFile
+      });
+
+      if (newSessionResult.cancelled) {
+        ctx.ui.notify('New session cancelled', 'info');
+        return;
+      }
+
+      // Set the edited prompt in the main editor for submission
+      ctx.ui.setEditorText(editedPrompt);
+      ctx.ui.notify('Handoff ready. Submit when ready.', 'info');
+    }
+  });
+}

package/agent-docs/examples/extensions/hello.ts

@@ -1,25 +1,25 @@
-/**
- * Hello Tool - Minimal custom tool example
- */
-
-import type { ExtensionAPI } from 'shortcutxl';
-import { Type } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  shortcut.registerTool({
-    name: 'hello',
-    label: 'Hello',
-    description: 'A simple greeting tool',
-    parameters: Type.Object({
-      name: Type.String({ description: 'Name to greet' })
-    }),
-
-    async execute(_toolCallId, params, _signal, _onUpdate, _ctx) {
-      const { name } = params as { name: string };
-      return {
-        content: [{ type: 'text', text: `Hello, ${name}!` }],
-        details: { greeted: name }
-      };
-    }
-  });
-}
+/**
+ * Hello Tool - Minimal custom tool example
+ */
+
+import type { ExtensionAPI } from 'shortcutxl';
+import { Type } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  shortcut.registerTool({
+    name: 'hello',
+    label: 'Hello',
+    description: 'A simple greeting tool',
+    parameters: Type.Object({
+      name: Type.String({ description: 'Name to greet' })
+    }),
+
+    async execute(_toolCallId, params, _signal, _onUpdate, _ctx) {
+      const { name } = params as { name: string };
+      return {
+        content: [{ type: 'text', text: `Hello, ${name}!` }],
+        details: { greeted: name }
+      };
+    }
+  });
+}

package/agent-docs/examples/extensions/inline-bash.ts

@@ -1,94 +1,94 @@
-/**
- * Inline Bash Extension - expands inline bash commands in user prompts.
- *
- * Start shortcut with this extension:
- *   shortcut -e ./examples/extensions/inline-bash.ts
- *
- * Then type prompts with inline bash:
- *   What's in !{pwd}?
- *   The current branch is !{git branch --show-current} and status: !{git status --short}
- *   My node version is !{node --version}
- *
- * The !{command} patterns are executed and replaced with their output before
- * the prompt is sent to the agent.
- *
- * Note: Regular !command syntax (whole-line bash) is preserved and works as before.
- */
-import type { ExtensionAPI } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  const PATTERN = /!\{([^}]+)\}/g;
-  const TIMEOUT_MS = 30000;
-
-  shortcut.on('input', async (event, ctx) => {
-    const text = event.text;
-
-    // Don't process if it's a whole-line bash command (starts with !)
-    // This preserves the existing !command behavior
-    if (text.trimStart().startsWith('!') && !text.trimStart().startsWith('!{')) {
-      return { action: 'continue' };
-    }
-
-    // Check if there are any inline bash patterns
-    if (!PATTERN.test(text)) {
-      return { action: 'continue' };
-    }
-
-    // Reset regex state after test()
-    PATTERN.lastIndex = 0;
-
-    let result = text;
-    const expansions: Array<{ command: string; output: string; error?: string }> = [];
-
-    // Find all matches first (to avoid issues with replacing while iterating)
-    const matches: Array<{ full: string; command: string }> = [];
-    let match = PATTERN.exec(text);
-    while (match) {
-      matches.push({ full: match[0], command: match[1] });
-      match = PATTERN.exec(text);
-    }
-
-    // Execute each command and collect results
-    for (const { full, command } of matches) {
-      try {
-        const bashResult = await shortcut.exec('bash', ['-c', command], {
-          timeout: TIMEOUT_MS
-        });
-
-        const output = bashResult.stdout || bashResult.stderr || '';
-        const trimmed = output.trim();
-
-        if (bashResult.code !== 0 && bashResult.stderr) {
-          expansions.push({
-            command,
-            output: trimmed,
-            error: `exit code ${bashResult.code}`
-          });
-        } else {
-          expansions.push({ command, output: trimmed });
-        }
-
-        result = result.replace(full, trimmed);
-      } catch (err) {
-        const errorMsg = err instanceof Error ? err.message : String(err);
-        expansions.push({ command, output: '', error: errorMsg });
-        result = result.replace(full, `[error: ${errorMsg}]`);
-      }
-    }
-
-    // Show what was expanded (if UI available)
-    if (ctx.hasUI && expansions.length > 0) {
-      const summary = expansions
-        .map((e) => {
-          const status = e.error ? ` (${e.error})` : '';
-          const preview = e.output.length > 50 ? `${e.output.slice(0, 50)}...` : e.output;
-          return `!{${e.command}}${status} -> "${preview}"`;
-        })
-        .join('\n');
-
-      ctx.ui.notify(`Expanded ${expansions.length} inline command(s):\n${summary}`, 'info');
-    }
-
-    return { action: 'transform', text: result, images: event.images };
-  });
-}
+/**
+ * Inline Bash Extension - expands inline bash commands in user prompts.
+ *
+ * Start shortcut with this extension:
+ *   shortcut -e ./examples/extensions/inline-bash.ts
+ *
+ * Then type prompts with inline bash:
+ *   What's in !{pwd}?
+ *   The current branch is !{git branch --show-current} and status: !{git status --short}
+ *   My node version is !{node --version}
+ *
+ * The !{command} patterns are executed and replaced with their output before
+ * the prompt is sent to the agent.
+ *
+ * Note: Regular !command syntax (whole-line bash) is preserved and works as before.
+ */
+import type { ExtensionAPI } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  const PATTERN = /!\{([^}]+)\}/g;
+  const TIMEOUT_MS = 30000;
+
+  shortcut.on('input', async (event, ctx) => {
+    const text = event.text;
+
+    // Don't process if it's a whole-line bash command (starts with !)
+    // This preserves the existing !command behavior
+    if (text.trimStart().startsWith('!') && !text.trimStart().startsWith('!{')) {
+      return { action: 'continue' };
+    }
+
+    // Check if there are any inline bash patterns
+    if (!PATTERN.test(text)) {
+      return { action: 'continue' };
+    }
+
+    // Reset regex state after test()
+    PATTERN.lastIndex = 0;
+
+    let result = text;
+    const expansions: Array<{ command: string; output: string; error?: string }> = [];
+
+    // Find all matches first (to avoid issues with replacing while iterating)
+    const matches: Array<{ full: string; command: string }> = [];
+    let match = PATTERN.exec(text);
+    while (match) {
+      matches.push({ full: match[0], command: match[1] });
+      match = PATTERN.exec(text);
+    }
+
+    // Execute each command and collect results
+    for (const { full, command } of matches) {
+      try {
+        const bashResult = await shortcut.exec('bash', ['-c', command], {
+          timeout: TIMEOUT_MS
+        });
+
+        const output = bashResult.stdout || bashResult.stderr || '';
+        const trimmed = output.trim();
+
+        if (bashResult.code !== 0 && bashResult.stderr) {
+          expansions.push({
+            command,
+            output: trimmed,
+            error: `exit code ${bashResult.code}`
+          });
+        } else {
+          expansions.push({ command, output: trimmed });
+        }
+
+        result = result.replace(full, trimmed);
+      } catch (err) {
+        const errorMsg = err instanceof Error ? err.message : String(err);
+        expansions.push({ command, output: '', error: errorMsg });
+        result = result.replace(full, `[error: ${errorMsg}]`);
+      }
+    }
+
+    // Show what was expanded (if UI available)
+    if (ctx.hasUI && expansions.length > 0) {
+      const summary = expansions
+        .map((e) => {
+          const status = e.error ? ` (${e.error})` : '';
+          const preview = e.output.length > 50 ? `${e.output.slice(0, 50)}...` : e.output;
+          return `!{${e.command}}${status} -> "${preview}"`;
+        })
+        .join('\n');
+
+      ctx.ui.notify(`Expanded ${expansions.length} inline command(s):\n${summary}`, 'info');
+    }
+
+    return { action: 'transform', text: result, images: event.images };
+  });
+}

package/agent-docs/examples/extensions/input-transform.ts

@@ -1,43 +1,43 @@
-/**
- * Input Transform Example - demonstrates the `input` event for intercepting user input.
- *
- * Start shortcut with this extension:
- *   shortcut -e ./examples/extensions/input-transform.ts
- *
- * Then type these inside shortcut:
- *   ?quick What is TypeScript?  → "Respond briefly: What is TypeScript?"
- *   ping                        → "pong" (instant, no LLM)
- *   time                        → current time (instant, no LLM)
- */
-import type { ExtensionAPI } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  shortcut.on('input', async (event, ctx) => {
-    // Source-based logic: skip processing for extension-injected messages
-    if (event.source === 'extension') {
-      return { action: 'continue' };
-    }
-
-    // Transform: ?quick prefix for brief responses
-    if (event.text.startsWith('?quick ')) {
-      const query = event.text.slice(7).trim();
-      if (!query) {
-        ctx.ui.notify('Usage: ?quick <question>', 'warning');
-        return { action: 'handled' };
-      }
-      return { action: 'transform', text: `Respond briefly in 1-2 sentences: ${query}` };
-    }
-
-    // Handle: instant responses without LLM (extension shows its own feedback)
-    if (event.text.toLowerCase() === 'ping') {
-      ctx.ui.notify('pong', 'info');
-      return { action: 'handled' };
-    }
-    if (event.text.toLowerCase() === 'time') {
-      ctx.ui.notify(new Date().toLocaleString(), 'info');
-      return { action: 'handled' };
-    }
-
-    return { action: 'continue' };
-  });
-}
+/**
+ * Input Transform Example - demonstrates the `input` event for intercepting user input.
+ *
+ * Start shortcut with this extension:
+ *   shortcut -e ./examples/extensions/input-transform.ts
+ *
+ * Then type these inside shortcut:
+ *   ?quick What is TypeScript?  → "Respond briefly: What is TypeScript?"
+ *   ping                        → "pong" (instant, no LLM)
+ *   time                        → current time (instant, no LLM)
+ */
+import type { ExtensionAPI } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  shortcut.on('input', async (event, ctx) => {
+    // Source-based logic: skip processing for extension-injected messages
+    if (event.source === 'extension') {
+      return { action: 'continue' };
+    }
+
+    // Transform: ?quick prefix for brief responses
+    if (event.text.startsWith('?quick ')) {
+      const query = event.text.slice(7).trim();
+      if (!query) {
+        ctx.ui.notify('Usage: ?quick <question>', 'warning');
+        return { action: 'handled' };
+      }
+      return { action: 'transform', text: `Respond briefly in 1-2 sentences: ${query}` };
+    }
+
+    // Handle: instant responses without LLM (extension shows its own feedback)
+    if (event.text.toLowerCase() === 'ping') {
+      ctx.ui.notify('pong', 'info');
+      return { action: 'handled' };
+    }
+    if (event.text.toLowerCase() === 'time') {
+      ctx.ui.notify(new Date().toLocaleString(), 'info');
+      return { action: 'handled' };
+    }
+
+    return { action: 'continue' };
+  });
+}