shortcutxl 0.2.12 → 0.2.13

package/agent-docs/examples/extensions/rainbow-editor.ts

@@ -1,90 +1,90 @@
-/**
- * Rainbow Editor - highlights "ultrathink" with animated shine effect
- *
- * Usage: shortcut --extension ./examples/extensions/rainbow-editor.ts
- */
-
-import { CustomEditor, type ExtensionAPI } from 'shortcutxl';
-
-// Base colors (coral → yellow → green → teal → blue → purple → pink)
-const COLORS: [number, number, number][] = [
-  [233, 137, 115], // coral
-  [228, 186, 103], // yellow
-  [141, 192, 122], // green
-  [102, 194, 179], // teal
-  [121, 157, 207], // blue
-  [157, 134, 195], // purple
-  [206, 130, 172] // pink
-];
-const RESET = '\x1b[0m';
-
-function brighten(rgb: [number, number, number], factor: number): string {
-  const [r, g, b] = rgb.map((c) => Math.round(c + (255 - c) * factor));
-  return `\x1b[38;2;${r};${g};${b}m`;
-}
-
-function colorize(text: string, shinePos: number): string {
-  return (
-    [...text]
-      .map((c, i) => {
-        const baseColor = COLORS[i % COLORS.length]!;
-        // 3-letter shine: center bright, adjacent dimmer
-        let factor = 0;
-        if (shinePos >= 0) {
-          const dist = Math.abs(i - shinePos);
-          if (dist === 0) factor = 0.7;
-          else if (dist === 1) factor = 0.35;
-        }
-        return `${brighten(baseColor, factor)}${c}`;
-      })
-      .join('') + RESET
-  );
-}
-
-class RainbowEditor extends CustomEditor {
-  private animationTimer?: ReturnType<typeof setInterval>;
-  private frame = 0;
-
-  private hasUltrathink(): boolean {
-    return /ultrathink/i.test(this.getText());
-  }
-
-  private startAnimation(): void {
-    if (this.animationTimer) return;
-    this.animationTimer = setInterval(() => {
-      this.frame++;
-      this.tui.requestRender();
-    }, 60);
-  }
-
-  private stopAnimation(): void {
-    if (this.animationTimer) {
-      clearInterval(this.animationTimer);
-      this.animationTimer = undefined;
-    }
-  }
-
-  handleInput(data: string): void {
-    super.handleInput(data);
-    if (this.hasUltrathink()) {
-      this.startAnimation();
-    } else {
-      this.stopAnimation();
-    }
-  }
-
-  render(width: number): string[] {
-    // Cycle: 10 shine positions + 10 pause frames
-    const cycle = this.frame % 20;
-    const shinePos = cycle < 10 ? cycle : -1; // -1 means no shine (pause)
-    return super
-      .render(width)
-      .map((line) => line.replace(/ultrathink/gi, (m) => colorize(m, shinePos)));
-  }
-}
-
-export default function (shortcut: ExtensionAPI) {
-  shortcut.on('session_start', (_event, ctx) => {
-    ctx.ui.setEditorComponent((tui, theme, kb) => new RainbowEditor(tui, theme, kb));
-  });
-}
+/**
+ * Rainbow Editor - highlights "ultrathink" with animated shine effect
+ *
+ * Usage: shortcut --extension ./examples/extensions/rainbow-editor.ts
+ */
+
+import { CustomEditor, type ExtensionAPI } from 'shortcutxl';
+
+// Base colors (coral → yellow → green → teal → blue → purple → pink)
+const COLORS: [number, number, number][] = [
+  [233, 137, 115], // coral
+  [228, 186, 103], // yellow
+  [141, 192, 122], // green
+  [102, 194, 179], // teal
+  [121, 157, 207], // blue
+  [157, 134, 195], // purple
+  [206, 130, 172] // pink
+];
+const RESET = '\x1b[0m';
+
+function brighten(rgb: [number, number, number], factor: number): string {
+  const [r, g, b] = rgb.map((c) => Math.round(c + (255 - c) * factor));
+  return `\x1b[38;2;${r};${g};${b}m`;
+}
+
+function colorize(text: string, shinePos: number): string {
+  return (
+    [...text]
+      .map((c, i) => {
+        const baseColor = COLORS[i % COLORS.length]!;
+        // 3-letter shine: center bright, adjacent dimmer
+        let factor = 0;
+        if (shinePos >= 0) {
+          const dist = Math.abs(i - shinePos);
+          if (dist === 0) factor = 0.7;
+          else if (dist === 1) factor = 0.35;
+        }
+        return `${brighten(baseColor, factor)}${c}`;
+      })
+      .join('') + RESET
+  );
+}
+
+class RainbowEditor extends CustomEditor {
+  private animationTimer?: ReturnType<typeof setInterval>;
+  private frame = 0;
+
+  private hasUltrathink(): boolean {
+    return /ultrathink/i.test(this.getText());
+  }
+
+  private startAnimation(): void {
+    if (this.animationTimer) return;
+    this.animationTimer = setInterval(() => {
+      this.frame++;
+      this.tui.requestRender();
+    }, 60);
+  }
+
+  private stopAnimation(): void {
+    if (this.animationTimer) {
+      clearInterval(this.animationTimer);
+      this.animationTimer = undefined;
+    }
+  }
+
+  handleInput(data: string): void {
+    super.handleInput(data);
+    if (this.hasUltrathink()) {
+      this.startAnimation();
+    } else {
+      this.stopAnimation();
+    }
+  }
+
+  render(width: number): string[] {
+    // Cycle: 10 shine positions + 10 pause frames
+    const cycle = this.frame % 20;
+    const shinePos = cycle < 10 ? cycle : -1; // -1 means no shine (pause)
+    return super
+      .render(width)
+      .map((line) => line.replace(/ultrathink/gi, (m) => colorize(m, shinePos)));
+  }
+}
+
+export default function (shortcut: ExtensionAPI) {
+  shortcut.on('session_start', (_event, ctx) => {
+    ctx.ui.setEditorComponent((tui, theme, kb) => new RainbowEditor(tui, theme, kb));
+  });
+}

package/agent-docs/examples/extensions/reload-runtime.ts

@@ -1,37 +1,37 @@
-/**
- * Reload Runtime Extension
- *
- * Demonstrates ctx.reload() from ExtensionCommandContext and an LLM-callable
- * tool that queues a follow-up command to trigger reload.
- */
-
-import { Type } from '@sinclair/typebox';
-import type { ExtensionAPI } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  // Command entrypoint for reload.
-  // Treat reload as terminal for this handler.
-  shortcut.registerCommand('reload-runtime', {
-    description: 'Reload extensions, skills, prompts, and themes',
-    handler: async (_args, ctx) => {
-      await ctx.reload();
-      return;
-    }
-  });
-
-  // LLM-callable tool. Tools get ExtensionContext, so they cannot call ctx.reload() directly.
-  // Instead, queue a follow-up user command that executes the command above.
-  shortcut.registerTool({
-    name: 'reload_runtime',
-    label: 'Reload Runtime',
-    description: 'Reload extensions, skills, prompts, and themes',
-    parameters: Type.Object({}),
-    async execute() {
-      shortcut.sendUserMessage('/reload-runtime', { deliverAs: 'followUp' });
-      return {
-        content: [{ type: 'text', text: 'Queued /reload-runtime as a follow-up command.' }],
-        details: {}
-      };
-    }
-  });
-}
+/**
+ * Reload Runtime Extension
+ *
+ * Demonstrates ctx.reload() from ExtensionCommandContext and an LLM-callable
+ * tool that queues a follow-up command to trigger reload.
+ */
+
+import { Type } from '@sinclair/typebox';
+import type { ExtensionAPI } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  // Command entrypoint for reload.
+  // Treat reload as terminal for this handler.
+  shortcut.registerCommand('reload-runtime', {
+    description: 'Reload extensions, skills, prompts, and themes',
+    handler: async (_args, ctx) => {
+      await ctx.reload();
+      return;
+    }
+  });
+
+  // LLM-callable tool. Tools get ExtensionContext, so they cannot call ctx.reload() directly.
+  // Instead, queue a follow-up user command that executes the command above.
+  shortcut.registerTool({
+    name: 'reload_runtime',
+    label: 'Reload Runtime',
+    description: 'Reload extensions, skills, prompts, and themes',
+    parameters: Type.Object({}),
+    async execute() {
+      shortcut.sendUserMessage('/reload-runtime', { deliverAs: 'followUp' });
+      return {
+        content: [{ type: 'text', text: 'Queued /reload-runtime as a follow-up command.' }],
+        details: {}
+      };
+    }
+  });
+}

package/agent-docs/examples/extensions/rpc-demo.ts

@@ -1,124 +1,124 @@
-/**
- * RPC Extension UI Demo
- *
- * Purpose-built extension that exercises all RPC-supported extension UI methods.
- * Designed to be loaded alongside the rpc-extension-ui-example.ts script to
- * demonstrate the full extension UI protocol.
- *
- * UI methods exercised:
- * - select() - on tool_call for dangerous bash commands
- * - confirm() - on session_before_switch
- * - input() - via /rpc-input command
- * - editor() - via /rpc-editor command
- * - notify() - after each dialog completes
- * - setStatus() - on turn_start/turn_end
- * - setWidget() - on session_start
- * - setTitle() - on session_start and session_switch
- * - setEditorText() - via /rpc-prefill command
- */
-
-import type { ExtensionAPI } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  let turnCount = 0;
-
-  // -- setTitle, setWidget, setStatus on session lifecycle --
-
-  shortcut.on('session_start', async (_event, ctx) => {
-    ctx.ui.setTitle('shortcut RPC Demo');
-    ctx.ui.setWidget('rpc-demo', ['--- RPC Extension UI Demo ---', 'Loaded and ready.']);
-    ctx.ui.setStatus('rpc-demo', `Turns: ${turnCount}`);
-  });
-
-  shortcut.on('session_switch', async (_event, ctx) => {
-    turnCount = 0;
-    ctx.ui.setTitle('shortcut RPC Demo (new session)');
-    ctx.ui.setStatus('rpc-demo', `Turns: ${turnCount}`);
-  });
-
-  // -- setStatus on turn lifecycle --
-
-  shortcut.on('turn_start', async (_event, ctx) => {
-    turnCount++;
-    ctx.ui.setStatus('rpc-demo', `Turn ${turnCount} running...`);
-  });
-
-  shortcut.on('turn_end', async (_event, ctx) => {
-    ctx.ui.setStatus('rpc-demo', `Turn ${turnCount} done`);
-  });
-
-  // -- select on dangerous tool calls --
-
-  shortcut.on('tool_call', async (event, ctx) => {
-    if (event.toolName !== 'bash') return undefined;
-
-    const command = event.input.command as string;
-    const isDangerous = /\brm\s+(-rf?|--recursive)/i.test(command) || /\bsudo\b/i.test(command);
-
-    if (isDangerous) {
-      if (!ctx.hasUI) {
-        return { block: true, reason: 'Dangerous command blocked (no UI)' };
-      }
-
-      const choice = await ctx.ui.select(`Dangerous command: ${command}`, ['Allow', 'Block']);
-      if (choice !== 'Allow') {
-        ctx.ui.notify('Command blocked by user', 'warning');
-        return { block: true, reason: 'Blocked by user' };
-      }
-      ctx.ui.notify('Command allowed', 'info');
-    }
-
-    return undefined;
-  });
-
-  // -- confirm on session clear --
-
-  shortcut.on('session_before_switch', async (event, ctx) => {
-    if (event.reason !== 'new') return;
-    if (!ctx.hasUI) return;
-
-    const confirmed = await ctx.ui.confirm('Clear session?', 'All messages will be lost.');
-    if (!confirmed) {
-      ctx.ui.notify('Clear cancelled', 'info');
-      return { cancel: true };
-    }
-  });
-
-  // -- input via command --
-
-  shortcut.registerCommand('rpc-input', {
-    description: 'Prompt for text input (demonstrates ctx.ui.input in RPC)',
-    handler: async (_args, ctx) => {
-      const value = await ctx.ui.input('Enter a value', 'type something...');
-      if (value) {
-        ctx.ui.notify(`You entered: ${value}`, 'info');
-      } else {
-        ctx.ui.notify('Input cancelled', 'info');
-      }
-    }
-  });
-
-  // -- editor via command --
-
-  shortcut.registerCommand('rpc-editor', {
-    description: 'Open multi-line editor (demonstrates ctx.ui.editor in RPC)',
-    handler: async (_args, ctx) => {
-      const text = await ctx.ui.editor('Edit some text', 'Line 1\nLine 2\nLine 3');
-      if (text) {
-        ctx.ui.notify(`Editor submitted (${text.split('\n').length} lines)`, 'info');
-      } else {
-        ctx.ui.notify('Editor cancelled', 'info');
-      }
-    }
-  });
-
-  // -- setEditorText via command --
-
-  shortcut.registerCommand('rpc-prefill', {
-    description: 'Prefill the input editor (demonstrates ctx.ui.setEditorText in RPC)',
-    handler: async (_args, ctx) => {
-      ctx.ui.setEditorText('This text was set by the rpc-demo extension.');
-      ctx.ui.notify('Editor prefilled', 'info');
-    }
-  });
-}
+/**
+ * RPC Extension UI Demo
+ *
+ * Purpose-built extension that exercises all RPC-supported extension UI methods.
+ * Designed to be loaded alongside the rpc-extension-ui-example.ts script to
+ * demonstrate the full extension UI protocol.
+ *
+ * UI methods exercised:
+ * - select() - on tool_call for dangerous bash commands
+ * - confirm() - on session_before_switch
+ * - input() - via /rpc-input command
+ * - editor() - via /rpc-editor command
+ * - notify() - after each dialog completes
+ * - setStatus() - on turn_start/turn_end
+ * - setWidget() - on session_start
+ * - setTitle() - on session_start and session_switch
+ * - setEditorText() - via /rpc-prefill command
+ */
+
+import type { ExtensionAPI } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  let turnCount = 0;
+
+  // -- setTitle, setWidget, setStatus on session lifecycle --
+
+  shortcut.on('session_start', async (_event, ctx) => {
+    ctx.ui.setTitle('shortcut RPC Demo');
+    ctx.ui.setWidget('rpc-demo', ['--- RPC Extension UI Demo ---', 'Loaded and ready.']);
+    ctx.ui.setStatus('rpc-demo', `Turns: ${turnCount}`);
+  });
+
+  shortcut.on('session_switch', async (_event, ctx) => {
+    turnCount = 0;
+    ctx.ui.setTitle('shortcut RPC Demo (new session)');
+    ctx.ui.setStatus('rpc-demo', `Turns: ${turnCount}`);
+  });
+
+  // -- setStatus on turn lifecycle --
+
+  shortcut.on('turn_start', async (_event, ctx) => {
+    turnCount++;
+    ctx.ui.setStatus('rpc-demo', `Turn ${turnCount} running...`);
+  });
+
+  shortcut.on('turn_end', async (_event, ctx) => {
+    ctx.ui.setStatus('rpc-demo', `Turn ${turnCount} done`);
+  });
+
+  // -- select on dangerous tool calls --
+
+  shortcut.on('tool_call', async (event, ctx) => {
+    if (event.toolName !== 'bash') return undefined;
+
+    const command = event.input.command as string;
+    const isDangerous = /\brm\s+(-rf?|--recursive)/i.test(command) || /\bsudo\b/i.test(command);
+
+    if (isDangerous) {
+      if (!ctx.hasUI) {
+        return { block: true, reason: 'Dangerous command blocked (no UI)' };
+      }
+
+      const choice = await ctx.ui.select(`Dangerous command: ${command}`, ['Allow', 'Block']);
+      if (choice !== 'Allow') {
+        ctx.ui.notify('Command blocked by user', 'warning');
+        return { block: true, reason: 'Blocked by user' };
+      }
+      ctx.ui.notify('Command allowed', 'info');
+    }
+
+    return undefined;
+  });
+
+  // -- confirm on session clear --
+
+  shortcut.on('session_before_switch', async (event, ctx) => {
+    if (event.reason !== 'new') return;
+    if (!ctx.hasUI) return;
+
+    const confirmed = await ctx.ui.confirm('Clear session?', 'All messages will be lost.');
+    if (!confirmed) {
+      ctx.ui.notify('Clear cancelled', 'info');
+      return { cancel: true };
+    }
+  });
+
+  // -- input via command --
+
+  shortcut.registerCommand('rpc-input', {
+    description: 'Prompt for text input (demonstrates ctx.ui.input in RPC)',
+    handler: async (_args, ctx) => {
+      const value = await ctx.ui.input('Enter a value', 'type something...');
+      if (value) {
+        ctx.ui.notify(`You entered: ${value}`, 'info');
+      } else {
+        ctx.ui.notify('Input cancelled', 'info');
+      }
+    }
+  });
+
+  // -- editor via command --
+
+  shortcut.registerCommand('rpc-editor', {
+    description: 'Open multi-line editor (demonstrates ctx.ui.editor in RPC)',
+    handler: async (_args, ctx) => {
+      const text = await ctx.ui.editor('Edit some text', 'Line 1\nLine 2\nLine 3');
+      if (text) {
+        ctx.ui.notify(`Editor submitted (${text.split('\n').length} lines)`, 'info');
+      } else {
+        ctx.ui.notify('Editor cancelled', 'info');
+      }
+    }
+  });
+
+  // -- setEditorText via command --
+
+  shortcut.registerCommand('rpc-prefill', {
+    description: 'Prefill the input editor (demonstrates ctx.ui.setEditorText in RPC)',
+    handler: async (_args, ctx) => {
+      ctx.ui.setEditorText('This text was set by the rpc-demo extension.');
+      ctx.ui.notify('Editor prefilled', 'info');
+    }
+  });
+}