shortcutxl 0.2.12 → 0.2.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (110) hide show
  1. package/README.md +26 -26
  2. package/agent-docs/README.md +397 -397
  3. package/agent-docs/docs/compaction.md +390 -390
  4. package/agent-docs/docs/custom-provider.md +580 -580
  5. package/agent-docs/docs/extensions.md +1971 -1971
  6. package/agent-docs/docs/packages.md +209 -209
  7. package/agent-docs/docs/rpc.md +1317 -1317
  8. package/agent-docs/docs/sdk.md +962 -962
  9. package/agent-docs/docs/session.md +412 -412
  10. package/agent-docs/docs/termux.md +127 -127
  11. package/agent-docs/docs/tui.md +887 -887
  12. package/agent-docs/examples/README.md +25 -25
  13. package/agent-docs/examples/extensions/README.md +205 -205
  14. package/agent-docs/examples/extensions/antigravity-image-gen.ts +447 -447
  15. package/agent-docs/examples/extensions/auto-commit-on-exit.ts +49 -49
  16. package/agent-docs/examples/extensions/bash-spawn-hook.ts +30 -30
  17. package/agent-docs/examples/extensions/bookmark.ts +50 -50
  18. package/agent-docs/examples/extensions/built-in-tool-renderer.ts +256 -256
  19. package/agent-docs/examples/extensions/claude-rules.ts +86 -86
  20. package/agent-docs/examples/extensions/commands.ts +75 -75
  21. package/agent-docs/examples/extensions/confirm-destructive.ts +59 -59
  22. package/agent-docs/examples/extensions/custom-compaction.ts +126 -126
  23. package/agent-docs/examples/extensions/custom-footer.ts +63 -63
  24. package/agent-docs/examples/extensions/custom-header.ts +73 -73
  25. package/agent-docs/examples/extensions/custom-provider-anthropic/index.ts +660 -660
  26. package/agent-docs/examples/extensions/custom-provider-gitlab-duo/index.ts +362 -362
  27. package/agent-docs/examples/extensions/custom-provider-gitlab-duo/test.ts +88 -88
  28. package/agent-docs/examples/extensions/custom-provider-qwen-cli/index.ts +349 -349
  29. package/agent-docs/examples/extensions/dirty-repo-guard.ts +56 -56
  30. package/agent-docs/examples/extensions/doom-overlay/doom-component.ts +133 -133
  31. package/agent-docs/examples/extensions/doom-overlay/doom-keys.ts +108 -108
  32. package/agent-docs/examples/extensions/doom-overlay/index.ts +74 -74
  33. package/agent-docs/examples/extensions/dynamic-resources/index.ts +15 -15
  34. package/agent-docs/examples/extensions/dynamic-tools.ts +77 -77
  35. package/agent-docs/examples/extensions/event-bus.ts +43 -43
  36. package/agent-docs/examples/extensions/file-trigger.ts +41 -41
  37. package/agent-docs/examples/extensions/git-checkpoint.ts +53 -53
  38. package/agent-docs/examples/extensions/handoff.ts +155 -155
  39. package/agent-docs/examples/extensions/hello.ts +25 -25
  40. package/agent-docs/examples/extensions/inline-bash.ts +94 -94
  41. package/agent-docs/examples/extensions/input-transform.ts +43 -43
  42. package/agent-docs/examples/extensions/interactive-shell.ts +209 -209
  43. package/agent-docs/examples/extensions/mac-system-theme.ts +47 -47
  44. package/agent-docs/examples/extensions/message-renderer.ts +59 -59
  45. package/agent-docs/examples/extensions/minimal-mode.ts +430 -430
  46. package/agent-docs/examples/extensions/modal-editor.ts +90 -90
  47. package/agent-docs/examples/extensions/model-status.ts +31 -31
  48. package/agent-docs/examples/extensions/notify.ts +55 -55
  49. package/agent-docs/examples/extensions/overlay-qa-tests.ts +936 -936
  50. package/agent-docs/examples/extensions/overlay-test.ts +159 -159
  51. package/agent-docs/examples/extensions/permission-gate.ts +37 -37
  52. package/agent-docs/examples/extensions/pirate.ts +47 -47
  53. package/agent-docs/examples/extensions/plan-mode/index.ts +363 -363
  54. package/agent-docs/examples/extensions/preset.ts +418 -418
  55. package/agent-docs/examples/extensions/protected-paths.ts +30 -30
  56. package/agent-docs/examples/extensions/qna.ts +122 -122
  57. package/agent-docs/examples/extensions/question.ts +278 -278
  58. package/agent-docs/examples/extensions/questionnaire.ts +440 -440
  59. package/agent-docs/examples/extensions/rainbow-editor.ts +90 -90
  60. package/agent-docs/examples/extensions/reload-runtime.ts +37 -37
  61. package/agent-docs/examples/extensions/rpc-demo.ts +124 -124
  62. package/agent-docs/examples/extensions/sandbox/index.ts +324 -324
  63. package/agent-docs/examples/extensions/send-user-message.ts +97 -97
  64. package/agent-docs/examples/extensions/session-name.ts +27 -27
  65. package/agent-docs/examples/extensions/shutdown-command.ts +69 -69
  66. package/agent-docs/examples/extensions/snake.ts +343 -343
  67. package/agent-docs/examples/extensions/space-invaders.ts +566 -566
  68. package/agent-docs/examples/extensions/ssh.ts +233 -233
  69. package/agent-docs/examples/extensions/status-line.ts +40 -40
  70. package/agent-docs/examples/extensions/subagent/agents.ts +130 -130
  71. package/agent-docs/examples/extensions/subagent/index.ts +1068 -1068
  72. package/agent-docs/examples/extensions/summarize.ts +206 -206
  73. package/agent-docs/examples/extensions/system-prompt-header.ts +17 -17
  74. package/agent-docs/examples/extensions/timed-confirm.ts +72 -72
  75. package/agent-docs/examples/extensions/titlebar-spinner.ts +58 -58
  76. package/agent-docs/examples/extensions/todo.ts +314 -314
  77. package/agent-docs/examples/extensions/tool-override.ts +146 -146
  78. package/agent-docs/examples/extensions/tools.ts +145 -145
  79. package/agent-docs/examples/extensions/trigger-compact.ts +40 -40
  80. package/agent-docs/examples/extensions/truncated-tool.ts +194 -194
  81. package/agent-docs/examples/extensions/widget-placement.ts +17 -17
  82. package/agent-docs/examples/extensions/with-deps/index.ts +37 -37
  83. package/agent-docs/examples/rpc-extension-ui.ts +654 -654
  84. package/agent-docs/examples/sdk/01-minimal.ts +22 -22
  85. package/agent-docs/examples/sdk/02-custom-model.ts +48 -48
  86. package/agent-docs/examples/sdk/03-custom-prompt.ts +55 -55
  87. package/agent-docs/examples/sdk/04-skills.ts +53 -53
  88. package/agent-docs/examples/sdk/05-tools.ts +56 -56
  89. package/agent-docs/examples/sdk/06-extensions.ts +88 -88
  90. package/agent-docs/examples/sdk/07-context-files.ts +40 -40
  91. package/agent-docs/examples/sdk/08-prompt-templates.ts +47 -47
  92. package/agent-docs/examples/sdk/09-api-keys-and-oauth.ts +48 -48
  93. package/agent-docs/examples/sdk/10-settings.ts +54 -54
  94. package/agent-docs/examples/sdk/11-sessions.ts +48 -48
  95. package/agent-docs/examples/sdk/12-full-control.ts +82 -82
  96. package/agent-docs/examples/sdk/README.md +144 -144
  97. package/agent-docs/xll-spec.md +110 -110
  98. package/dist/core/auth-storage.js +21 -2
  99. package/package.json +1 -1
  100. package/xll/ShortcutXL.xll +0 -0
  101. package/xll/modules/debug_render.py +272 -272
  102. package/xll/modules/gameboy.py +241 -241
  103. package/xll/modules/pong.py +188 -188
  104. package/xll/modules/shortcut_xl/_diff_highlight.py +176 -0
  105. package/xll/modules/shortcut_xl/_log.py +12 -12
  106. package/xll/modules/shortcut_xl/_registry.py +44 -44
  107. package/xll/modules/stocks.py +100 -100
  108. /package/skills/{com-advanced-api → COM-advanced-api}/SKILL.md +0 -0
  109. /package/skills/{com-advanced-api → COM-advanced-api}/excel-type-library.py +0 -0
  110. /package/skills/{com-advanced-api → COM-advanced-api}/office-type-library.py +0 -0
@@ -1,418 +1,418 @@
1
- /**
2
- * Preset Extension
3
- *
4
- * Allows defining named presets that configure model, thinking level, tools,
5
- * and system prompt instructions. Presets are defined in JSON config files
6
- * and can be activated via CLI flag, /preset command, or Ctrl+Shift+U to cycle.
7
- *
8
- * Config files (merged, project takes precedence):
9
- * - ~/.shortcut/agent/presets.json (global)
10
- * - <cwd>/.shortcut/presets.json (project-local)
11
- *
12
- * Example presets.json:
13
- * ```json
14
- * {
15
- * "plan": {
16
- * "provider": "openai-codex",
17
- * "model": "gpt-5.2-codex",
18
- * "thinkingLevel": "high",
19
- * "tools": ["read", "grep", "find", "ls"],
20
- * "instructions": "You are in PLANNING MODE. Your job is to deeply understand the problem and create a detailed implementation plan.\n\nRules:\n- DO NOT make any changes. You cannot edit or write files.\n- Read files IN FULL (no offset/limit) to get complete context. Partial reads miss critical details.\n- Explore thoroughly: grep for related code, find similar patterns, understand the architecture.\n- Ask clarifying questions if requirements are ambiguous. Do not assume.\n- Identify risks, edge cases, and dependencies before proposing solutions.\n\nOutput:\n- Create a structured plan with numbered steps.\n- For each step: what to change, why, and potential risks.\n- List files that will be modified.\n- Note any tests that should be added or updated.\n\nWhen done, ask the user if they want you to:\n1. Write the plan to a markdown file (e.g., PLAN.md)\n2. Create a GitHub issue with the plan\n3. Proceed to implementation (they should switch to 'implement' preset)"
21
- * },
22
- * "implement": {
23
- * "provider": "anthropic",
24
- * "model": "claude-sonnet-4-5",
25
- * "thinkingLevel": "high",
26
- * "tools": ["read", "bash", "edit", "write"],
27
- * "instructions": "You are in IMPLEMENTATION MODE. Your job is to make focused, correct changes.\n\nRules:\n- Keep scope tight. Do exactly what was asked, no more.\n- Read files before editing to understand current state.\n- Make surgical edits. Prefer edit over write for existing files.\n- Explain your reasoning briefly before each change.\n- Run tests or type checks after changes if the project has them (npm test, npm run check, etc.).\n- If you encounter unexpected complexity, STOP and explain the issue rather than hacking around it.\n\nIf no plan exists:\n- Ask clarifying questions before starting.\n- Propose what you'll do and get confirmation for non-trivial changes.\n\nAfter completing changes:\n- Summarize what was done.\n- Note any follow-up work or tests that should be added."
28
- * }
29
- * }
30
- * ```
31
- *
32
- * Usage:
33
- * - `shortcut --preset plan` - start with plan preset
34
- * - `/preset` - show selector to switch presets mid-session
35
- * - `/preset implement` - switch to implement preset directly
36
- * - `Ctrl+Shift+U` - cycle through presets
37
- *
38
- * CLI flags always override preset values.
39
- */
40
-
41
- import { existsSync, readFileSync } from 'node:fs';
42
- import { homedir } from 'node:os';
43
- import { join } from 'node:path';
44
- import type { ExtensionAPI, ExtensionContext } from 'shortcutxl';
45
- import { Container, DynamicBorder, Key, type SelectItem, SelectList, Text } from 'shortcutxl';
46
-
47
- // Preset configuration
48
- interface Preset {
49
- /** Provider name (e.g., "anthropic", "openai") */
50
- provider?: string;
51
- /** Model ID (e.g., "claude-sonnet-4-5") */
52
- model?: string;
53
- /** Thinking level */
54
- thinkingLevel?: 'off' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh';
55
- /** Tools to enable (replaces default set) */
56
- tools?: string[];
57
- /** Instructions to append to system prompt */
58
- instructions?: string;
59
- }
60
-
61
- interface PresetsConfig {
62
- [name: string]: Preset;
63
- }
64
-
65
- /**
66
- * Load presets from config files.
67
- * Project-local presets override global presets with the same name.
68
- */
69
- function loadPresets(cwd: string): PresetsConfig {
70
- const globalPath = join(homedir(), '.shortcut', 'agent', 'presets.json');
71
- const projectPath = join(cwd, '.shortcut', 'presets.json');
72
-
73
- let globalPresets: PresetsConfig = {};
74
- let projectPresets: PresetsConfig = {};
75
-
76
- // Load global presets
77
- if (existsSync(globalPath)) {
78
- try {
79
- const content = readFileSync(globalPath, 'utf-8');
80
- globalPresets = JSON.parse(content);
81
- } catch (err) {
82
- console.error(`Failed to load global presets from ${globalPath}: ${err}`);
83
- }
84
- }
85
-
86
- // Load project presets
87
- if (existsSync(projectPath)) {
88
- try {
89
- const content = readFileSync(projectPath, 'utf-8');
90
- projectPresets = JSON.parse(content);
91
- } catch (err) {
92
- console.error(`Failed to load project presets from ${projectPath}: ${err}`);
93
- }
94
- }
95
-
96
- // Merge (project overrides global)
97
- return { ...globalPresets, ...projectPresets };
98
- }
99
-
100
- export default function presetExtension(shortcut: ExtensionAPI) {
101
- let presets: PresetsConfig = {};
102
- let activePresetName: string | undefined;
103
- let activePreset: Preset | undefined;
104
-
105
- // Register --preset CLI flag
106
- shortcut.registerFlag('preset', {
107
- description: 'Preset configuration to use',
108
- type: 'string'
109
- });
110
-
111
- /**
112
- * Apply a preset configuration.
113
- */
114
- async function applyPreset(
115
- name: string,
116
- preset: Preset,
117
- ctx: ExtensionContext
118
- ): Promise<boolean> {
119
- // Apply model if specified
120
- if (preset.provider && preset.model) {
121
- const model = ctx.modelRegistry.find(preset.provider, preset.model);
122
- if (model) {
123
- const success = await shortcut.setModel(model);
124
- if (!success) {
125
- ctx.ui.notify(
126
- `Preset "${name}": No API key for ${preset.provider}/${preset.model}`,
127
- 'warning'
128
- );
129
- }
130
- } else {
131
- ctx.ui.notify(
132
- `Preset "${name}": Model ${preset.provider}/${preset.model} not found`,
133
- 'warning'
134
- );
135
- }
136
- }
137
-
138
- // Apply thinking level if specified
139
- if (preset.thinkingLevel) {
140
- shortcut.setThinkingLevel(preset.thinkingLevel);
141
- }
142
-
143
- // Apply tools if specified
144
- if (preset.tools && preset.tools.length > 0) {
145
- const allToolNames = shortcut.getAllTools().map((t) => t.name);
146
- const validTools = preset.tools.filter((t) => allToolNames.includes(t));
147
- const invalidTools = preset.tools.filter((t) => !allToolNames.includes(t));
148
-
149
- if (invalidTools.length > 0) {
150
- ctx.ui.notify(`Preset "${name}": Unknown tools: ${invalidTools.join(', ')}`, 'warning');
151
- }
152
-
153
- if (validTools.length > 0) {
154
- shortcut.setActiveTools(validTools);
155
- }
156
- }
157
-
158
- // Store active preset for system prompt injection
159
- activePresetName = name;
160
- activePreset = preset;
161
-
162
- return true;
163
- }
164
-
165
- /**
166
- * Build description string for a preset.
167
- */
168
- function buildPresetDescription(preset: Preset): string {
169
- const parts: string[] = [];
170
-
171
- if (preset.provider && preset.model) {
172
- parts.push(`${preset.provider}/${preset.model}`);
173
- }
174
- if (preset.thinkingLevel) {
175
- parts.push(`thinking:${preset.thinkingLevel}`);
176
- }
177
- if (preset.tools) {
178
- parts.push(`tools:${preset.tools.join(',')}`);
179
- }
180
- if (preset.instructions) {
181
- const truncated =
182
- preset.instructions.length > 30
183
- ? `${preset.instructions.slice(0, 27)}...`
184
- : preset.instructions;
185
- parts.push(`"${truncated}"`);
186
- }
187
-
188
- return parts.join(' | ');
189
- }
190
-
191
- /**
192
- * Show preset selector UI using custom SelectList component.
193
- */
194
- async function showPresetSelector(ctx: ExtensionContext): Promise<void> {
195
- const presetNames = Object.keys(presets);
196
-
197
- if (presetNames.length === 0) {
198
- ctx.ui.notify(
199
- 'No presets defined. Add presets to ~/.shortcut/agent/presets.json or .shortcut/presets.json',
200
- 'warning'
201
- );
202
- return;
203
- }
204
-
205
- // Build select items with descriptions
206
- const items: SelectItem[] = presetNames.map((name) => {
207
- const preset = presets[name];
208
- const isActive = name === activePresetName;
209
- return {
210
- value: name,
211
- label: isActive ? `${name} (active)` : name,
212
- description: buildPresetDescription(preset)
213
- };
214
- });
215
-
216
- // Add "None" option to clear preset
217
- items.push({
218
- value: '(none)',
219
- label: '(none)',
220
- description: 'Clear active preset, restore defaults'
221
- });
222
-
223
- const result = await ctx.ui.custom<string | null>((tui, theme, _kb, done) => {
224
- const container = new Container();
225
- container.addChild(new DynamicBorder((str) => theme.fg('accent', str)));
226
-
227
- // Header
228
- container.addChild(new Text(theme.fg('accent', theme.bold('Select Preset'))));
229
-
230
- // SelectList with themed styling
231
- const selectList = new SelectList(items, Math.min(items.length, 10), {
232
- selectedPrefix: (text) => theme.fg('accent', text),
233
- selectedText: (text) => theme.fg('accent', text),
234
- description: (text) => theme.fg('muted', text),
235
- scrollInfo: (text) => theme.fg('dim', text),
236
- noMatch: (text) => theme.fg('warning', text)
237
- });
238
-
239
- selectList.onSelect = (item) => done(item.value);
240
- selectList.onCancel = () => done(null);
241
-
242
- container.addChild(selectList);
243
-
244
- // Footer hint
245
- container.addChild(new Text(theme.fg('dim', '↑↓ navigate • enter select • esc cancel')));
246
-
247
- container.addChild(new DynamicBorder((str) => theme.fg('accent', str)));
248
-
249
- return {
250
- render(width: number) {
251
- return container.render(width);
252
- },
253
- invalidate() {
254
- container.invalidate();
255
- },
256
- handleInput(data: string) {
257
- selectList.handleInput(data);
258
- tui.requestRender();
259
- }
260
- };
261
- });
262
-
263
- if (!result) return;
264
-
265
- if (result === '(none)') {
266
- // Clear preset and restore defaults
267
- activePresetName = undefined;
268
- activePreset = undefined;
269
- shortcut.setActiveTools(['read', 'bash', 'edit', 'write']);
270
- ctx.ui.notify('Preset cleared, defaults restored', 'info');
271
- updateStatus(ctx);
272
- return;
273
- }
274
-
275
- const preset = presets[result];
276
- if (preset) {
277
- await applyPreset(result, preset, ctx);
278
- ctx.ui.notify(`Preset "${result}" activated`, 'info');
279
- updateStatus(ctx);
280
- }
281
- }
282
-
283
- /**
284
- * Update status indicator.
285
- */
286
- function updateStatus(ctx: ExtensionContext) {
287
- if (activePresetName) {
288
- ctx.ui.setStatus('preset', ctx.ui.theme.fg('accent', `preset:${activePresetName}`));
289
- } else {
290
- ctx.ui.setStatus('preset', undefined);
291
- }
292
- }
293
-
294
- function getPresetOrder(): string[] {
295
- return Object.keys(presets).sort();
296
- }
297
-
298
- async function cyclePreset(ctx: ExtensionContext): Promise<void> {
299
- const presetNames = getPresetOrder();
300
- if (presetNames.length === 0) {
301
- ctx.ui.notify(
302
- 'No presets defined. Add presets to ~/.shortcut/agent/presets.json or .shortcut/presets.json',
303
- 'warning'
304
- );
305
- return;
306
- }
307
-
308
- const cycleList = ['(none)', ...presetNames];
309
- const currentName = activePresetName ?? '(none)';
310
- const currentIndex = cycleList.indexOf(currentName);
311
- const nextIndex = currentIndex === -1 ? 0 : (currentIndex + 1) % cycleList.length;
312
- const nextName = cycleList[nextIndex];
313
-
314
- if (nextName === '(none)') {
315
- activePresetName = undefined;
316
- activePreset = undefined;
317
- shortcut.setActiveTools(['read', 'bash', 'edit', 'write']);
318
- ctx.ui.notify('Preset cleared, defaults restored', 'info');
319
- updateStatus(ctx);
320
- return;
321
- }
322
-
323
- const preset = presets[nextName];
324
- if (!preset) return;
325
-
326
- await applyPreset(nextName, preset, ctx);
327
- ctx.ui.notify(`Preset "${nextName}" activated`, 'info');
328
- updateStatus(ctx);
329
- }
330
-
331
- shortcut.registerShortcut(Key.ctrlShift('u'), {
332
- description: 'Cycle presets',
333
- handler: async (ctx) => {
334
- await cyclePreset(ctx);
335
- }
336
- });
337
-
338
- // Register /preset command
339
- shortcut.registerCommand('preset', {
340
- description: 'Switch preset configuration',
341
- handler: async (args, ctx) => {
342
- // If preset name provided, apply directly
343
- if (args?.trim()) {
344
- const name = args.trim();
345
- const preset = presets[name];
346
-
347
- if (!preset) {
348
- const available = Object.keys(presets).join(', ') || '(none defined)';
349
- ctx.ui.notify(`Unknown preset "${name}". Available: ${available}`, 'error');
350
- return;
351
- }
352
-
353
- await applyPreset(name, preset, ctx);
354
- ctx.ui.notify(`Preset "${name}" activated`, 'info');
355
- updateStatus(ctx);
356
- return;
357
- }
358
-
359
- // Otherwise show selector
360
- await showPresetSelector(ctx);
361
- }
362
- });
363
-
364
- // Inject preset instructions into system prompt
365
- shortcut.on('before_agent_start', async (event) => {
366
- if (activePreset?.instructions) {
367
- return {
368
- systemPrompt: `${event.systemPrompt}\n\n${activePreset.instructions}`
369
- };
370
- }
371
- });
372
-
373
- // Initialize on session start
374
- shortcut.on('session_start', async (_event, ctx) => {
375
- // Load presets from config files
376
- presets = loadPresets(ctx.cwd);
377
-
378
- // Check for --preset flag
379
- const presetFlag = shortcut.getFlag('preset');
380
- if (typeof presetFlag === 'string' && presetFlag) {
381
- const preset = presets[presetFlag];
382
- if (preset) {
383
- await applyPreset(presetFlag, preset, ctx);
384
- ctx.ui.notify(`Preset "${presetFlag}" activated`, 'info');
385
- } else {
386
- const available = Object.keys(presets).join(', ') || '(none defined)';
387
- ctx.ui.notify(`Unknown preset "${presetFlag}". Available: ${available}`, 'warning');
388
- }
389
- }
390
-
391
- // Restore preset from session state
392
- const entries = ctx.sessionManager.getEntries();
393
- const presetEntry = entries
394
- .filter(
395
- (e: { type: string; customType?: string }) =>
396
- e.type === 'custom' && e.customType === 'preset-state'
397
- )
398
- .pop() as { data?: { name: string } } | undefined;
399
-
400
- if (presetEntry?.data?.name && !presetFlag) {
401
- const preset = presets[presetEntry.data.name];
402
- if (preset) {
403
- activePresetName = presetEntry.data.name;
404
- activePreset = preset;
405
- // Don't re-apply model/tools on restore, just keep the name for instructions
406
- }
407
- }
408
-
409
- updateStatus(ctx);
410
- });
411
-
412
- // Persist preset state
413
- shortcut.on('turn_start', async () => {
414
- if (activePresetName) {
415
- shortcut.appendEntry('preset-state', { name: activePresetName });
416
- }
417
- });
418
- }
1
+ /**
2
+ * Preset Extension
3
+ *
4
+ * Allows defining named presets that configure model, thinking level, tools,
5
+ * and system prompt instructions. Presets are defined in JSON config files
6
+ * and can be activated via CLI flag, /preset command, or Ctrl+Shift+U to cycle.
7
+ *
8
+ * Config files (merged, project takes precedence):
9
+ * - ~/.shortcut/agent/presets.json (global)
10
+ * - <cwd>/.shortcut/presets.json (project-local)
11
+ *
12
+ * Example presets.json:
13
+ * ```json
14
+ * {
15
+ * "plan": {
16
+ * "provider": "openai-codex",
17
+ * "model": "gpt-5.2-codex",
18
+ * "thinkingLevel": "high",
19
+ * "tools": ["read", "grep", "find", "ls"],
20
+ * "instructions": "You are in PLANNING MODE. Your job is to deeply understand the problem and create a detailed implementation plan.\n\nRules:\n- DO NOT make any changes. You cannot edit or write files.\n- Read files IN FULL (no offset/limit) to get complete context. Partial reads miss critical details.\n- Explore thoroughly: grep for related code, find similar patterns, understand the architecture.\n- Ask clarifying questions if requirements are ambiguous. Do not assume.\n- Identify risks, edge cases, and dependencies before proposing solutions.\n\nOutput:\n- Create a structured plan with numbered steps.\n- For each step: what to change, why, and potential risks.\n- List files that will be modified.\n- Note any tests that should be added or updated.\n\nWhen done, ask the user if they want you to:\n1. Write the plan to a markdown file (e.g., PLAN.md)\n2. Create a GitHub issue with the plan\n3. Proceed to implementation (they should switch to 'implement' preset)"
21
+ * },
22
+ * "implement": {
23
+ * "provider": "anthropic",
24
+ * "model": "claude-sonnet-4-5",
25
+ * "thinkingLevel": "high",
26
+ * "tools": ["read", "bash", "edit", "write"],
27
+ * "instructions": "You are in IMPLEMENTATION MODE. Your job is to make focused, correct changes.\n\nRules:\n- Keep scope tight. Do exactly what was asked, no more.\n- Read files before editing to understand current state.\n- Make surgical edits. Prefer edit over write for existing files.\n- Explain your reasoning briefly before each change.\n- Run tests or type checks after changes if the project has them (npm test, npm run check, etc.).\n- If you encounter unexpected complexity, STOP and explain the issue rather than hacking around it.\n\nIf no plan exists:\n- Ask clarifying questions before starting.\n- Propose what you'll do and get confirmation for non-trivial changes.\n\nAfter completing changes:\n- Summarize what was done.\n- Note any follow-up work or tests that should be added."
28
+ * }
29
+ * }
30
+ * ```
31
+ *
32
+ * Usage:
33
+ * - `shortcut --preset plan` - start with plan preset
34
+ * - `/preset` - show selector to switch presets mid-session
35
+ * - `/preset implement` - switch to implement preset directly
36
+ * - `Ctrl+Shift+U` - cycle through presets
37
+ *
38
+ * CLI flags always override preset values.
39
+ */
40
+
41
+ import { existsSync, readFileSync } from 'node:fs';
42
+ import { homedir } from 'node:os';
43
+ import { join } from 'node:path';
44
+ import type { ExtensionAPI, ExtensionContext } from 'shortcutxl';
45
+ import { Container, DynamicBorder, Key, type SelectItem, SelectList, Text } from 'shortcutxl';
46
+
47
+ // Preset configuration
48
+ interface Preset {
49
+ /** Provider name (e.g., "anthropic", "openai") */
50
+ provider?: string;
51
+ /** Model ID (e.g., "claude-sonnet-4-5") */
52
+ model?: string;
53
+ /** Thinking level */
54
+ thinkingLevel?: 'off' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh';
55
+ /** Tools to enable (replaces default set) */
56
+ tools?: string[];
57
+ /** Instructions to append to system prompt */
58
+ instructions?: string;
59
+ }
60
+
61
+ interface PresetsConfig {
62
+ [name: string]: Preset;
63
+ }
64
+
65
+ /**
66
+ * Load presets from config files.
67
+ * Project-local presets override global presets with the same name.
68
+ */
69
+ function loadPresets(cwd: string): PresetsConfig {
70
+ const globalPath = join(homedir(), '.shortcut', 'agent', 'presets.json');
71
+ const projectPath = join(cwd, '.shortcut', 'presets.json');
72
+
73
+ let globalPresets: PresetsConfig = {};
74
+ let projectPresets: PresetsConfig = {};
75
+
76
+ // Load global presets
77
+ if (existsSync(globalPath)) {
78
+ try {
79
+ const content = readFileSync(globalPath, 'utf-8');
80
+ globalPresets = JSON.parse(content);
81
+ } catch (err) {
82
+ console.error(`Failed to load global presets from ${globalPath}: ${err}`);
83
+ }
84
+ }
85
+
86
+ // Load project presets
87
+ if (existsSync(projectPath)) {
88
+ try {
89
+ const content = readFileSync(projectPath, 'utf-8');
90
+ projectPresets = JSON.parse(content);
91
+ } catch (err) {
92
+ console.error(`Failed to load project presets from ${projectPath}: ${err}`);
93
+ }
94
+ }
95
+
96
+ // Merge (project overrides global)
97
+ return { ...globalPresets, ...projectPresets };
98
+ }
99
+
100
+ export default function presetExtension(shortcut: ExtensionAPI) {
101
+ let presets: PresetsConfig = {};
102
+ let activePresetName: string | undefined;
103
+ let activePreset: Preset | undefined;
104
+
105
+ // Register --preset CLI flag
106
+ shortcut.registerFlag('preset', {
107
+ description: 'Preset configuration to use',
108
+ type: 'string'
109
+ });
110
+
111
+ /**
112
+ * Apply a preset configuration.
113
+ */
114
+ async function applyPreset(
115
+ name: string,
116
+ preset: Preset,
117
+ ctx: ExtensionContext
118
+ ): Promise<boolean> {
119
+ // Apply model if specified
120
+ if (preset.provider && preset.model) {
121
+ const model = ctx.modelRegistry.find(preset.provider, preset.model);
122
+ if (model) {
123
+ const success = await shortcut.setModel(model);
124
+ if (!success) {
125
+ ctx.ui.notify(
126
+ `Preset "${name}": No API key for ${preset.provider}/${preset.model}`,
127
+ 'warning'
128
+ );
129
+ }
130
+ } else {
131
+ ctx.ui.notify(
132
+ `Preset "${name}": Model ${preset.provider}/${preset.model} not found`,
133
+ 'warning'
134
+ );
135
+ }
136
+ }
137
+
138
+ // Apply thinking level if specified
139
+ if (preset.thinkingLevel) {
140
+ shortcut.setThinkingLevel(preset.thinkingLevel);
141
+ }
142
+
143
+ // Apply tools if specified
144
+ if (preset.tools && preset.tools.length > 0) {
145
+ const allToolNames = shortcut.getAllTools().map((t) => t.name);
146
+ const validTools = preset.tools.filter((t) => allToolNames.includes(t));
147
+ const invalidTools = preset.tools.filter((t) => !allToolNames.includes(t));
148
+
149
+ if (invalidTools.length > 0) {
150
+ ctx.ui.notify(`Preset "${name}": Unknown tools: ${invalidTools.join(', ')}`, 'warning');
151
+ }
152
+
153
+ if (validTools.length > 0) {
154
+ shortcut.setActiveTools(validTools);
155
+ }
156
+ }
157
+
158
+ // Store active preset for system prompt injection
159
+ activePresetName = name;
160
+ activePreset = preset;
161
+
162
+ return true;
163
+ }
164
+
165
+ /**
166
+ * Build description string for a preset.
167
+ */
168
+ function buildPresetDescription(preset: Preset): string {
169
+ const parts: string[] = [];
170
+
171
+ if (preset.provider && preset.model) {
172
+ parts.push(`${preset.provider}/${preset.model}`);
173
+ }
174
+ if (preset.thinkingLevel) {
175
+ parts.push(`thinking:${preset.thinkingLevel}`);
176
+ }
177
+ if (preset.tools) {
178
+ parts.push(`tools:${preset.tools.join(',')}`);
179
+ }
180
+ if (preset.instructions) {
181
+ const truncated =
182
+ preset.instructions.length > 30
183
+ ? `${preset.instructions.slice(0, 27)}...`
184
+ : preset.instructions;
185
+ parts.push(`"${truncated}"`);
186
+ }
187
+
188
+ return parts.join(' | ');
189
+ }
190
+
191
+ /**
192
+ * Show preset selector UI using custom SelectList component.
193
+ */
194
+ async function showPresetSelector(ctx: ExtensionContext): Promise<void> {
195
+ const presetNames = Object.keys(presets);
196
+
197
+ if (presetNames.length === 0) {
198
+ ctx.ui.notify(
199
+ 'No presets defined. Add presets to ~/.shortcut/agent/presets.json or .shortcut/presets.json',
200
+ 'warning'
201
+ );
202
+ return;
203
+ }
204
+
205
+ // Build select items with descriptions
206
+ const items: SelectItem[] = presetNames.map((name) => {
207
+ const preset = presets[name];
208
+ const isActive = name === activePresetName;
209
+ return {
210
+ value: name,
211
+ label: isActive ? `${name} (active)` : name,
212
+ description: buildPresetDescription(preset)
213
+ };
214
+ });
215
+
216
+ // Add "None" option to clear preset
217
+ items.push({
218
+ value: '(none)',
219
+ label: '(none)',
220
+ description: 'Clear active preset, restore defaults'
221
+ });
222
+
223
+ const result = await ctx.ui.custom<string | null>((tui, theme, _kb, done) => {
224
+ const container = new Container();
225
+ container.addChild(new DynamicBorder((str) => theme.fg('accent', str)));
226
+
227
+ // Header
228
+ container.addChild(new Text(theme.fg('accent', theme.bold('Select Preset'))));
229
+
230
+ // SelectList with themed styling
231
+ const selectList = new SelectList(items, Math.min(items.length, 10), {
232
+ selectedPrefix: (text) => theme.fg('accent', text),
233
+ selectedText: (text) => theme.fg('accent', text),
234
+ description: (text) => theme.fg('muted', text),
235
+ scrollInfo: (text) => theme.fg('dim', text),
236
+ noMatch: (text) => theme.fg('warning', text)
237
+ });
238
+
239
+ selectList.onSelect = (item) => done(item.value);
240
+ selectList.onCancel = () => done(null);
241
+
242
+ container.addChild(selectList);
243
+
244
+ // Footer hint
245
+ container.addChild(new Text(theme.fg('dim', '↑↓ navigate • enter select • esc cancel')));
246
+
247
+ container.addChild(new DynamicBorder((str) => theme.fg('accent', str)));
248
+
249
+ return {
250
+ render(width: number) {
251
+ return container.render(width);
252
+ },
253
+ invalidate() {
254
+ container.invalidate();
255
+ },
256
+ handleInput(data: string) {
257
+ selectList.handleInput(data);
258
+ tui.requestRender();
259
+ }
260
+ };
261
+ });
262
+
263
+ if (!result) return;
264
+
265
+ if (result === '(none)') {
266
+ // Clear preset and restore defaults
267
+ activePresetName = undefined;
268
+ activePreset = undefined;
269
+ shortcut.setActiveTools(['read', 'bash', 'edit', 'write']);
270
+ ctx.ui.notify('Preset cleared, defaults restored', 'info');
271
+ updateStatus(ctx);
272
+ return;
273
+ }
274
+
275
+ const preset = presets[result];
276
+ if (preset) {
277
+ await applyPreset(result, preset, ctx);
278
+ ctx.ui.notify(`Preset "${result}" activated`, 'info');
279
+ updateStatus(ctx);
280
+ }
281
+ }
282
+
283
+ /**
284
+ * Update status indicator.
285
+ */
286
+ function updateStatus(ctx: ExtensionContext) {
287
+ if (activePresetName) {
288
+ ctx.ui.setStatus('preset', ctx.ui.theme.fg('accent', `preset:${activePresetName}`));
289
+ } else {
290
+ ctx.ui.setStatus('preset', undefined);
291
+ }
292
+ }
293
+
294
+ function getPresetOrder(): string[] {
295
+ return Object.keys(presets).sort();
296
+ }
297
+
298
+ async function cyclePreset(ctx: ExtensionContext): Promise<void> {
299
+ const presetNames = getPresetOrder();
300
+ if (presetNames.length === 0) {
301
+ ctx.ui.notify(
302
+ 'No presets defined. Add presets to ~/.shortcut/agent/presets.json or .shortcut/presets.json',
303
+ 'warning'
304
+ );
305
+ return;
306
+ }
307
+
308
+ const cycleList = ['(none)', ...presetNames];
309
+ const currentName = activePresetName ?? '(none)';
310
+ const currentIndex = cycleList.indexOf(currentName);
311
+ const nextIndex = currentIndex === -1 ? 0 : (currentIndex + 1) % cycleList.length;
312
+ const nextName = cycleList[nextIndex];
313
+
314
+ if (nextName === '(none)') {
315
+ activePresetName = undefined;
316
+ activePreset = undefined;
317
+ shortcut.setActiveTools(['read', 'bash', 'edit', 'write']);
318
+ ctx.ui.notify('Preset cleared, defaults restored', 'info');
319
+ updateStatus(ctx);
320
+ return;
321
+ }
322
+
323
+ const preset = presets[nextName];
324
+ if (!preset) return;
325
+
326
+ await applyPreset(nextName, preset, ctx);
327
+ ctx.ui.notify(`Preset "${nextName}" activated`, 'info');
328
+ updateStatus(ctx);
329
+ }
330
+
331
+ shortcut.registerShortcut(Key.ctrlShift('u'), {
332
+ description: 'Cycle presets',
333
+ handler: async (ctx) => {
334
+ await cyclePreset(ctx);
335
+ }
336
+ });
337
+
338
+ // Register /preset command
339
+ shortcut.registerCommand('preset', {
340
+ description: 'Switch preset configuration',
341
+ handler: async (args, ctx) => {
342
+ // If preset name provided, apply directly
343
+ if (args?.trim()) {
344
+ const name = args.trim();
345
+ const preset = presets[name];
346
+
347
+ if (!preset) {
348
+ const available = Object.keys(presets).join(', ') || '(none defined)';
349
+ ctx.ui.notify(`Unknown preset "${name}". Available: ${available}`, 'error');
350
+ return;
351
+ }
352
+
353
+ await applyPreset(name, preset, ctx);
354
+ ctx.ui.notify(`Preset "${name}" activated`, 'info');
355
+ updateStatus(ctx);
356
+ return;
357
+ }
358
+
359
+ // Otherwise show selector
360
+ await showPresetSelector(ctx);
361
+ }
362
+ });
363
+
364
+ // Inject preset instructions into system prompt
365
+ shortcut.on('before_agent_start', async (event) => {
366
+ if (activePreset?.instructions) {
367
+ return {
368
+ systemPrompt: `${event.systemPrompt}\n\n${activePreset.instructions}`
369
+ };
370
+ }
371
+ });
372
+
373
+ // Initialize on session start
374
+ shortcut.on('session_start', async (_event, ctx) => {
375
+ // Load presets from config files
376
+ presets = loadPresets(ctx.cwd);
377
+
378
+ // Check for --preset flag
379
+ const presetFlag = shortcut.getFlag('preset');
380
+ if (typeof presetFlag === 'string' && presetFlag) {
381
+ const preset = presets[presetFlag];
382
+ if (preset) {
383
+ await applyPreset(presetFlag, preset, ctx);
384
+ ctx.ui.notify(`Preset "${presetFlag}" activated`, 'info');
385
+ } else {
386
+ const available = Object.keys(presets).join(', ') || '(none defined)';
387
+ ctx.ui.notify(`Unknown preset "${presetFlag}". Available: ${available}`, 'warning');
388
+ }
389
+ }
390
+
391
+ // Restore preset from session state
392
+ const entries = ctx.sessionManager.getEntries();
393
+ const presetEntry = entries
394
+ .filter(
395
+ (e: { type: string; customType?: string }) =>
396
+ e.type === 'custom' && e.customType === 'preset-state'
397
+ )
398
+ .pop() as { data?: { name: string } } | undefined;
399
+
400
+ if (presetEntry?.data?.name && !presetFlag) {
401
+ const preset = presets[presetEntry.data.name];
402
+ if (preset) {
403
+ activePresetName = presetEntry.data.name;
404
+ activePreset = preset;
405
+ // Don't re-apply model/tools on restore, just keep the name for instructions
406
+ }
407
+ }
408
+
409
+ updateStatus(ctx);
410
+ });
411
+
412
+ // Persist preset state
413
+ shortcut.on('turn_start', async () => {
414
+ if (activePresetName) {
415
+ shortcut.appendEntry('preset-state', { name: activePresetName });
416
+ }
417
+ });
418
+ }