shortcutxl 0.2.12 → 0.2.13

package/agent-docs/examples/extensions/interactive-shell.ts

@@ -1,209 +1,209 @@
-/**
- * Interactive Shell Commands Extension
- *
- * Enables running interactive commands (vim, git rebase -i, htop, etc.)
- * with full terminal access. The TUI suspends while they run.
- *
- * Usage:
- *   shortcut -e examples/extensions/interactive-shell.ts
- *
- *   !vim file.txt        # Auto-detected as interactive
- *   !i any-command       # Force interactive mode with !i prefix
- *   !git rebase -i HEAD~3
- *   !htop
- *
- * Configuration via environment variables:
- *   INTERACTIVE_COMMANDS - Additional commands (comma-separated)
- *   INTERACTIVE_EXCLUDE  - Commands to exclude (comma-separated)
- *
- * Note: This only intercepts user `!` commands, not agent bash tool calls.
- * If the agent runs an interactive command, it will fail (which is fine).
- */
-
-import { spawnSync } from 'node:child_process';
-import type { ExtensionAPI } from 'shortcutxl';
-
-// Default interactive commands - editors, pagers, git ops, TUIs
-const DEFAULT_INTERACTIVE_COMMANDS = [
-  // Editors
-  'vim',
-  'nvim',
-  'vi',
-  'nano',
-  'emacs',
-  'pico',
-  'micro',
-  'helix',
-  'hx',
-  'kak',
-  // Pagers
-  'less',
-  'more',
-  'most',
-  // Git interactive
-  'git commit',
-  'git rebase',
-  'git merge',
-  'git cherry-pick',
-  'git revert',
-  'git add -p',
-  'git add --patch',
-  'git add -i',
-  'git add --interactive',
-  'git stash -p',
-  'git stash --patch',
-  'git reset -p',
-  'git reset --patch',
-  'git checkout -p',
-  'git checkout --patch',
-  'git difftool',
-  'git mergetool',
-  // System monitors
-  'htop',
-  'top',
-  'btop',
-  'glances',
-  // File managers
-  'ranger',
-  'nnn',
-  'lf',
-  'mc',
-  'vifm',
-  // Git TUIs
-  'tig',
-  'lazygit',
-  'gitui',
-  // Fuzzy finders
-  'fzf',
-  'sk',
-  // Remote sessions
-  'ssh',
-  'telnet',
-  'mosh',
-  // Database clients
-  'psql',
-  'mysql',
-  'sqlite3',
-  'mongosh',
-  'redis-cli',
-  // Kubernetes/Docker
-  'kubectl edit',
-  'kubectl exec -it',
-  'docker exec -it',
-  'docker run -it',
-  // Other
-  'tmux',
-  'screen',
-  'ncdu'
-];
-
-function getInteractiveCommands(): string[] {
-  const additional =
-    process.env.INTERACTIVE_COMMANDS?.split(',')
-      .map((s) => s.trim())
-      .filter(Boolean) ?? [];
-  const excluded = new Set(
-    process.env.INTERACTIVE_EXCLUDE?.split(',').map((s) => s.trim().toLowerCase()) ?? []
-  );
-  return [...DEFAULT_INTERACTIVE_COMMANDS, ...additional].filter(
-    (cmd) => !excluded.has(cmd.toLowerCase())
-  );
-}
-
-function isInteractiveCommand(command: string): boolean {
-  const trimmed = command.trim().toLowerCase();
-  const commands = getInteractiveCommands();
-
-  for (const cmd of commands) {
-    const cmdLower = cmd.toLowerCase();
-    // Match at start
-    if (
-      trimmed === cmdLower ||
-      trimmed.startsWith(`${cmdLower} `) ||
-      trimmed.startsWith(`${cmdLower}\t`)
-    ) {
-      return true;
-    }
-    // Match after pipe: "cat file | less"
-    const pipeIdx = trimmed.lastIndexOf('|');
-    if (pipeIdx !== -1) {
-      const afterPipe = trimmed.slice(pipeIdx + 1).trim();
-      if (afterPipe === cmdLower || afterPipe.startsWith(`${cmdLower} `)) {
-        return true;
-      }
-    }
-  }
-  return false;
-}
-
-export default function (shortcut: ExtensionAPI) {
-  shortcut.on('user_bash', async (event, ctx) => {
-    let command = event.command;
-    let forceInteractive = false;
-
-    // Check for !i prefix (command comes without the leading !)
-    // The prefix parsing happens before this event, so we check if command starts with "i "
-    if (command.startsWith('i ') || command.startsWith('i\t')) {
-      forceInteractive = true;
-      command = command.slice(2).trim();
-    }
-
-    const shouldBeInteractive = forceInteractive || isInteractiveCommand(command);
-    if (!shouldBeInteractive) {
-      return; // Let normal handling proceed
-    }
-
-    // No UI available (print mode, RPC, etc.)
-    if (!ctx.hasUI) {
-      return {
-        result: {
-          output: '(interactive commands require TUI)',
-          exitCode: 1,
-          cancelled: false,
-          truncated: false
-        }
-      };
-    }
-
-    // Use ctx.ui.custom() to get TUI access, then run the command
-    const exitCode = await ctx.ui.custom<number | null>((tui, _theme, _kb, done) => {
-      // Stop TUI to release terminal
-      tui.stop();
-
-      // Clear screen
-      process.stdout.write('\x1b[2J\x1b[H');
-
-      // Run command with full terminal access
-      const shell = process.env.SHELL || '/bin/sh';
-      const result = spawnSync(shell, ['-c', command], {
-        stdio: 'inherit',
-        env: process.env
-      });
-
-      // Restart TUI
-      tui.start();
-      tui.requestRender(true);
-
-      // Signal completion
-      done(result.status);
-
-      // Return empty component (immediately disposed since done() was called)
-      return { render: () => [], invalidate: () => {} };
-    });
-
-    // Return result to prevent default bash handling
-    const output =
-      exitCode === 0
-        ? '(interactive command completed successfully)'
-        : `(interactive command exited with code ${exitCode})`;
-
-    return {
-      result: {
-        output,
-        exitCode: exitCode ?? 1,
-        cancelled: false,
-        truncated: false
-      }
-    };
-  });
-}
+/**
+ * Interactive Shell Commands Extension
+ *
+ * Enables running interactive commands (vim, git rebase -i, htop, etc.)
+ * with full terminal access. The TUI suspends while they run.
+ *
+ * Usage:
+ *   shortcut -e examples/extensions/interactive-shell.ts
+ *
+ *   !vim file.txt        # Auto-detected as interactive
+ *   !i any-command       # Force interactive mode with !i prefix
+ *   !git rebase -i HEAD~3
+ *   !htop
+ *
+ * Configuration via environment variables:
+ *   INTERACTIVE_COMMANDS - Additional commands (comma-separated)
+ *   INTERACTIVE_EXCLUDE  - Commands to exclude (comma-separated)
+ *
+ * Note: This only intercepts user `!` commands, not agent bash tool calls.
+ * If the agent runs an interactive command, it will fail (which is fine).
+ */
+
+import { spawnSync } from 'node:child_process';
+import type { ExtensionAPI } from 'shortcutxl';
+
+// Default interactive commands - editors, pagers, git ops, TUIs
+const DEFAULT_INTERACTIVE_COMMANDS = [
+  // Editors
+  'vim',
+  'nvim',
+  'vi',
+  'nano',
+  'emacs',
+  'pico',
+  'micro',
+  'helix',
+  'hx',
+  'kak',
+  // Pagers
+  'less',
+  'more',
+  'most',
+  // Git interactive
+  'git commit',
+  'git rebase',
+  'git merge',
+  'git cherry-pick',
+  'git revert',
+  'git add -p',
+  'git add --patch',
+  'git add -i',
+  'git add --interactive',
+  'git stash -p',
+  'git stash --patch',
+  'git reset -p',
+  'git reset --patch',
+  'git checkout -p',
+  'git checkout --patch',
+  'git difftool',
+  'git mergetool',
+  // System monitors
+  'htop',
+  'top',
+  'btop',
+  'glances',
+  // File managers
+  'ranger',
+  'nnn',
+  'lf',
+  'mc',
+  'vifm',
+  // Git TUIs
+  'tig',
+  'lazygit',
+  'gitui',
+  // Fuzzy finders
+  'fzf',
+  'sk',
+  // Remote sessions
+  'ssh',
+  'telnet',
+  'mosh',
+  // Database clients
+  'psql',
+  'mysql',
+  'sqlite3',
+  'mongosh',
+  'redis-cli',
+  // Kubernetes/Docker
+  'kubectl edit',
+  'kubectl exec -it',
+  'docker exec -it',
+  'docker run -it',
+  // Other
+  'tmux',
+  'screen',
+  'ncdu'
+];
+
+function getInteractiveCommands(): string[] {
+  const additional =
+    process.env.INTERACTIVE_COMMANDS?.split(',')
+      .map((s) => s.trim())
+      .filter(Boolean) ?? [];
+  const excluded = new Set(
+    process.env.INTERACTIVE_EXCLUDE?.split(',').map((s) => s.trim().toLowerCase()) ?? []
+  );
+  return [...DEFAULT_INTERACTIVE_COMMANDS, ...additional].filter(
+    (cmd) => !excluded.has(cmd.toLowerCase())
+  );
+}
+
+function isInteractiveCommand(command: string): boolean {
+  const trimmed = command.trim().toLowerCase();
+  const commands = getInteractiveCommands();
+
+  for (const cmd of commands) {
+    const cmdLower = cmd.toLowerCase();
+    // Match at start
+    if (
+      trimmed === cmdLower ||
+      trimmed.startsWith(`${cmdLower} `) ||
+      trimmed.startsWith(`${cmdLower}\t`)
+    ) {
+      return true;
+    }
+    // Match after pipe: "cat file | less"
+    const pipeIdx = trimmed.lastIndexOf('|');
+    if (pipeIdx !== -1) {
+      const afterPipe = trimmed.slice(pipeIdx + 1).trim();
+      if (afterPipe === cmdLower || afterPipe.startsWith(`${cmdLower} `)) {
+        return true;
+      }
+    }
+  }
+  return false;
+}
+
+export default function (shortcut: ExtensionAPI) {
+  shortcut.on('user_bash', async (event, ctx) => {
+    let command = event.command;
+    let forceInteractive = false;
+
+    // Check for !i prefix (command comes without the leading !)
+    // The prefix parsing happens before this event, so we check if command starts with "i "
+    if (command.startsWith('i ') || command.startsWith('i\t')) {
+      forceInteractive = true;
+      command = command.slice(2).trim();
+    }
+
+    const shouldBeInteractive = forceInteractive || isInteractiveCommand(command);
+    if (!shouldBeInteractive) {
+      return; // Let normal handling proceed
+    }
+
+    // No UI available (print mode, RPC, etc.)
+    if (!ctx.hasUI) {
+      return {
+        result: {
+          output: '(interactive commands require TUI)',
+          exitCode: 1,
+          cancelled: false,
+          truncated: false
+        }
+      };
+    }
+
+    // Use ctx.ui.custom() to get TUI access, then run the command
+    const exitCode = await ctx.ui.custom<number | null>((tui, _theme, _kb, done) => {
+      // Stop TUI to release terminal
+      tui.stop();
+
+      // Clear screen
+      process.stdout.write('\x1b[2J\x1b[H');
+
+      // Run command with full terminal access
+      const shell = process.env.SHELL || '/bin/sh';
+      const result = spawnSync(shell, ['-c', command], {
+        stdio: 'inherit',
+        env: process.env
+      });
+
+      // Restart TUI
+      tui.start();
+      tui.requestRender(true);
+
+      // Signal completion
+      done(result.status);
+
+      // Return empty component (immediately disposed since done() was called)
+      return { render: () => [], invalidate: () => {} };
+    });
+
+    // Return result to prevent default bash handling
+    const output =
+      exitCode === 0
+        ? '(interactive command completed successfully)'
+        : `(interactive command exited with code ${exitCode})`;
+
+    return {
+      result: {
+        output,
+        exitCode: exitCode ?? 1,
+        cancelled: false,
+        truncated: false
+      }
+    };
+  });
+}

package/agent-docs/examples/extensions/mac-system-theme.ts

@@ -1,47 +1,47 @@
-/**
- * Syncs shortcut theme with macOS system appearance (dark/light mode).
- *
- * Usage:
- *   shortcut -e examples/extensions/mac-system-theme.ts
- */
-
-import { exec } from 'node:child_process';
-import { promisify } from 'node:util';
-import type { ExtensionAPI } from 'shortcutxl';
-
-const execAsync = promisify(exec);
-
-async function isDarkMode(): Promise<boolean> {
-  try {
-    const { stdout } = await execAsync(
-      'osascript -e \'tell application "System Events" to tell appearance preferences to return dark mode\''
-    );
-    return stdout.trim() === 'true';
-  } catch {
-    return false;
-  }
-}
-
-export default function (shortcut: ExtensionAPI) {
-  let intervalId: ReturnType<typeof setInterval> | null = null;
-
-  shortcut.on('session_start', async (_event, ctx) => {
-    let currentTheme = (await isDarkMode()) ? 'dark' : 'light';
-    ctx.ui.setTheme(currentTheme);
-
-    intervalId = setInterval(async () => {
-      const newTheme = (await isDarkMode()) ? 'dark' : 'light';
-      if (newTheme !== currentTheme) {
-        currentTheme = newTheme;
-        ctx.ui.setTheme(currentTheme);
-      }
-    }, 2000);
-  });
-
-  shortcut.on('session_shutdown', () => {
-    if (intervalId) {
-      clearInterval(intervalId);
-      intervalId = null;
-    }
-  });
-}
+/**
+ * Syncs shortcut theme with macOS system appearance (dark/light mode).
+ *
+ * Usage:
+ *   shortcut -e examples/extensions/mac-system-theme.ts
+ */
+
+import { exec } from 'node:child_process';
+import { promisify } from 'node:util';
+import type { ExtensionAPI } from 'shortcutxl';
+
+const execAsync = promisify(exec);
+
+async function isDarkMode(): Promise<boolean> {
+  try {
+    const { stdout } = await execAsync(
+      'osascript -e \'tell application "System Events" to tell appearance preferences to return dark mode\''
+    );
+    return stdout.trim() === 'true';
+  } catch {
+    return false;
+  }
+}
+
+export default function (shortcut: ExtensionAPI) {
+  let intervalId: ReturnType<typeof setInterval> | null = null;
+
+  shortcut.on('session_start', async (_event, ctx) => {
+    let currentTheme = (await isDarkMode()) ? 'dark' : 'light';
+    ctx.ui.setTheme(currentTheme);
+
+    intervalId = setInterval(async () => {
+      const newTheme = (await isDarkMode()) ? 'dark' : 'light';
+      if (newTheme !== currentTheme) {
+        currentTheme = newTheme;
+        ctx.ui.setTheme(currentTheme);
+      }
+    }, 2000);
+  });
+
+  shortcut.on('session_shutdown', () => {
+    if (intervalId) {
+      clearInterval(intervalId);
+      intervalId = null;
+    }
+  });
+}

package/agent-docs/examples/extensions/message-renderer.ts

@@ -1,59 +1,59 @@
-/**
- * Custom message rendering example.
- *
- * Shows how to use registerMessageRenderer to control how custom messages
- * appear in the TUI, with colors, formatting, and expandable details.
- *
- * Usage: /status [message] - sends a status message with custom rendering
- */
-
-import type { ExtensionAPI } from 'shortcutxl';
-import { Box, Text } from 'shortcutxl';
-
-export default function (shortcut: ExtensionAPI) {
-  // Register custom renderer for "status-update" messages
-  shortcut.registerMessageRenderer('status-update', (message, { expanded }, theme) => {
-    const details = message.details as { level: string; timestamp: number } | undefined;
-    const level = details?.level ?? 'info';
-
-    // Color based on level
-    const color = level === 'error' ? 'error' : level === 'warn' ? 'warning' : 'success';
-    const prefix = theme.fg(color, `[${level.toUpperCase()}]`);
-
-    let text = `${prefix} ${message.content}`;
-
-    // Show timestamp when expanded
-    if (expanded && details?.timestamp) {
-      const time = new Date(details.timestamp).toLocaleTimeString();
-      text += `\n${theme.fg('dim', `  at ${time}`)}`;
-    }
-
-    // Use Box with customMessageBg for consistent styling
-    const box = new Box(1, 1, (t) => theme.bg('customMessageBg', t));
-    box.addChild(new Text(text, 0, 0));
-    return box;
-  });
-
-  // Command to send status messages
-  shortcut.registerCommand('status', {
-    description: 'Send a status message (usage: /status [warn|error] message)',
-    handler: async (args, _ctx) => {
-      const parts = args.trim().split(/\s+/);
-      let level = 'info';
-      let content = args.trim();
-
-      // Check for level prefix
-      if (parts[0] === 'warn' || parts[0] === 'error') {
-        level = parts[0];
-        content = parts.slice(1).join(' ') || 'Status update';
-      }
-
-      shortcut.sendMessage({
-        customType: 'status-update',
-        content,
-        display: true,
-        details: { level, timestamp: Date.now() }
-      });
-    }
-  });
-}
+/**
+ * Custom message rendering example.
+ *
+ * Shows how to use registerMessageRenderer to control how custom messages
+ * appear in the TUI, with colors, formatting, and expandable details.
+ *
+ * Usage: /status [message] - sends a status message with custom rendering
+ */
+
+import type { ExtensionAPI } from 'shortcutxl';
+import { Box, Text } from 'shortcutxl';
+
+export default function (shortcut: ExtensionAPI) {
+  // Register custom renderer for "status-update" messages
+  shortcut.registerMessageRenderer('status-update', (message, { expanded }, theme) => {
+    const details = message.details as { level: string; timestamp: number } | undefined;
+    const level = details?.level ?? 'info';
+
+    // Color based on level
+    const color = level === 'error' ? 'error' : level === 'warn' ? 'warning' : 'success';
+    const prefix = theme.fg(color, `[${level.toUpperCase()}]`);
+
+    let text = `${prefix} ${message.content}`;
+
+    // Show timestamp when expanded
+    if (expanded && details?.timestamp) {
+      const time = new Date(details.timestamp).toLocaleTimeString();
+      text += `\n${theme.fg('dim', `  at ${time}`)}`;
+    }
+
+    // Use Box with customMessageBg for consistent styling
+    const box = new Box(1, 1, (t) => theme.bg('customMessageBg', t));
+    box.addChild(new Text(text, 0, 0));
+    return box;
+  });
+
+  // Command to send status messages
+  shortcut.registerCommand('status', {
+    description: 'Send a status message (usage: /status [warn|error] message)',
+    handler: async (args, _ctx) => {
+      const parts = args.trim().split(/\s+/);
+      let level = 'info';
+      let content = args.trim();
+
+      // Check for level prefix
+      if (parts[0] === 'warn' || parts[0] === 'error') {
+        level = parts[0];
+        content = parts.slice(1).join(' ') || 'Status update';
+      }
+
+      shortcut.sendMessage({
+        customType: 'status-update',
+        content,
+        display: true,
+        details: { level, timestamp: Date.now() }
+      });
+    }
+  });
+}