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.
- package/README.md +26 -26
- package/agent-docs/README.md +397 -397
- package/agent-docs/docs/compaction.md +390 -390
- package/agent-docs/docs/custom-provider.md +580 -580
- package/agent-docs/docs/extensions.md +1971 -1971
- package/agent-docs/docs/packages.md +209 -209
- package/agent-docs/docs/rpc.md +1317 -1317
- package/agent-docs/docs/sdk.md +962 -962
- package/agent-docs/docs/session.md +412 -412
- package/agent-docs/docs/termux.md +127 -127
- package/agent-docs/docs/tui.md +887 -887
- package/agent-docs/examples/README.md +25 -25
- package/agent-docs/examples/extensions/README.md +205 -205
- package/agent-docs/examples/extensions/antigravity-image-gen.ts +447 -447
- package/agent-docs/examples/extensions/auto-commit-on-exit.ts +49 -49
- package/agent-docs/examples/extensions/bash-spawn-hook.ts +30 -30
- package/agent-docs/examples/extensions/bookmark.ts +50 -50
- package/agent-docs/examples/extensions/built-in-tool-renderer.ts +256 -256
- package/agent-docs/examples/extensions/claude-rules.ts +86 -86
- package/agent-docs/examples/extensions/commands.ts +75 -75
- package/agent-docs/examples/extensions/confirm-destructive.ts +59 -59
- package/agent-docs/examples/extensions/custom-compaction.ts +126 -126
- package/agent-docs/examples/extensions/custom-footer.ts +63 -63
- package/agent-docs/examples/extensions/custom-header.ts +73 -73
- package/agent-docs/examples/extensions/custom-provider-anthropic/index.ts +660 -660
- package/agent-docs/examples/extensions/custom-provider-gitlab-duo/index.ts +362 -362
- package/agent-docs/examples/extensions/custom-provider-gitlab-duo/test.ts +88 -88
- package/agent-docs/examples/extensions/custom-provider-qwen-cli/index.ts +349 -349
- package/agent-docs/examples/extensions/dirty-repo-guard.ts +56 -56
- package/agent-docs/examples/extensions/doom-overlay/doom-component.ts +133 -133
- package/agent-docs/examples/extensions/doom-overlay/doom-keys.ts +108 -108
- package/agent-docs/examples/extensions/doom-overlay/index.ts +74 -74
- package/agent-docs/examples/extensions/dynamic-resources/index.ts +15 -15
- package/agent-docs/examples/extensions/dynamic-tools.ts +77 -77
- package/agent-docs/examples/extensions/event-bus.ts +43 -43
- package/agent-docs/examples/extensions/file-trigger.ts +41 -41
- package/agent-docs/examples/extensions/git-checkpoint.ts +53 -53
- package/agent-docs/examples/extensions/handoff.ts +155 -155
- package/agent-docs/examples/extensions/hello.ts +25 -25
- package/agent-docs/examples/extensions/inline-bash.ts +94 -94
- package/agent-docs/examples/extensions/input-transform.ts +43 -43
- package/agent-docs/examples/extensions/interactive-shell.ts +209 -209
- package/agent-docs/examples/extensions/mac-system-theme.ts +47 -47
- package/agent-docs/examples/extensions/message-renderer.ts +59 -59
- package/agent-docs/examples/extensions/minimal-mode.ts +430 -430
- package/agent-docs/examples/extensions/modal-editor.ts +90 -90
- package/agent-docs/examples/extensions/model-status.ts +31 -31
- package/agent-docs/examples/extensions/notify.ts +55 -55
- package/agent-docs/examples/extensions/overlay-qa-tests.ts +936 -936
- package/agent-docs/examples/extensions/overlay-test.ts +159 -159
- package/agent-docs/examples/extensions/permission-gate.ts +37 -37
- package/agent-docs/examples/extensions/pirate.ts +47 -47
- package/agent-docs/examples/extensions/plan-mode/index.ts +363 -363
- package/agent-docs/examples/extensions/preset.ts +418 -418
- package/agent-docs/examples/extensions/protected-paths.ts +30 -30
- package/agent-docs/examples/extensions/qna.ts +122 -122
- package/agent-docs/examples/extensions/question.ts +278 -278
- package/agent-docs/examples/extensions/questionnaire.ts +440 -440
- package/agent-docs/examples/extensions/rainbow-editor.ts +90 -90
- package/agent-docs/examples/extensions/reload-runtime.ts +37 -37
- package/agent-docs/examples/extensions/rpc-demo.ts +124 -124
- package/agent-docs/examples/extensions/sandbox/index.ts +324 -324
- package/agent-docs/examples/extensions/send-user-message.ts +97 -97
- package/agent-docs/examples/extensions/session-name.ts +27 -27
- package/agent-docs/examples/extensions/shutdown-command.ts +69 -69
- package/agent-docs/examples/extensions/snake.ts +343 -343
- package/agent-docs/examples/extensions/space-invaders.ts +566 -566
- package/agent-docs/examples/extensions/ssh.ts +233 -233
- package/agent-docs/examples/extensions/status-line.ts +40 -40
- package/agent-docs/examples/extensions/subagent/agents.ts +130 -130
- package/agent-docs/examples/extensions/subagent/index.ts +1068 -1068
- package/agent-docs/examples/extensions/summarize.ts +206 -206
- package/agent-docs/examples/extensions/system-prompt-header.ts +17 -17
- package/agent-docs/examples/extensions/timed-confirm.ts +72 -72
- package/agent-docs/examples/extensions/titlebar-spinner.ts +58 -58
- package/agent-docs/examples/extensions/todo.ts +314 -314
- package/agent-docs/examples/extensions/tool-override.ts +146 -146
- package/agent-docs/examples/extensions/tools.ts +145 -145
- package/agent-docs/examples/extensions/trigger-compact.ts +40 -40
- package/agent-docs/examples/extensions/truncated-tool.ts +194 -194
- package/agent-docs/examples/extensions/widget-placement.ts +17 -17
- package/agent-docs/examples/extensions/with-deps/index.ts +37 -37
- package/agent-docs/examples/rpc-extension-ui.ts +654 -654
- package/agent-docs/examples/sdk/01-minimal.ts +22 -22
- package/agent-docs/examples/sdk/02-custom-model.ts +48 -48
- package/agent-docs/examples/sdk/03-custom-prompt.ts +55 -55
- package/agent-docs/examples/sdk/04-skills.ts +53 -53
- package/agent-docs/examples/sdk/05-tools.ts +56 -56
- package/agent-docs/examples/sdk/06-extensions.ts +88 -88
- package/agent-docs/examples/sdk/07-context-files.ts +40 -40
- package/agent-docs/examples/sdk/08-prompt-templates.ts +47 -47
- package/agent-docs/examples/sdk/09-api-keys-and-oauth.ts +48 -48
- package/agent-docs/examples/sdk/10-settings.ts +54 -54
- package/agent-docs/examples/sdk/11-sessions.ts +48 -48
- package/agent-docs/examples/sdk/12-full-control.ts +82 -82
- package/agent-docs/examples/sdk/README.md +144 -144
- package/agent-docs/xll-spec.md +110 -110
- package/dist/core/auth-storage.js +21 -2
- package/package.json +1 -1
- package/xll/ShortcutXL.xll +0 -0
- package/xll/modules/debug_render.py +272 -272
- package/xll/modules/gameboy.py +241 -241
- package/xll/modules/pong.py +188 -188
- package/xll/modules/shortcut_xl/_diff_highlight.py +176 -0
- package/xll/modules/shortcut_xl/_log.py +12 -12
- package/xll/modules/shortcut_xl/_registry.py +44 -44
- package/xll/modules/stocks.py +100 -100
- /package/skills/{com-advanced-api → COM-advanced-api}/SKILL.md +0 -0
- /package/skills/{com-advanced-api → COM-advanced-api}/excel-type-library.py +0 -0
- /package/skills/{com-advanced-api → COM-advanced-api}/office-type-library.py +0 -0
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Protected Paths Extension
|
|
3
|
-
*
|
|
4
|
-
* Blocks write and edit operations to protected paths.
|
|
5
|
-
* Useful for preventing accidental modifications to sensitive files.
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import type { ExtensionAPI } from 'shortcutxl';
|
|
9
|
-
|
|
10
|
-
export default function (shortcut: ExtensionAPI) {
|
|
11
|
-
const protectedPaths = ['.env', '.git/', 'node_modules/'];
|
|
12
|
-
|
|
13
|
-
shortcut.on('tool_call', async (event, ctx) => {
|
|
14
|
-
if (event.toolName !== 'write' && event.toolName !== 'edit') {
|
|
15
|
-
return undefined;
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
const path = event.input.path as string;
|
|
19
|
-
const isProtected = protectedPaths.some((p) => path.includes(p));
|
|
20
|
-
|
|
21
|
-
if (isProtected) {
|
|
22
|
-
if (ctx.hasUI) {
|
|
23
|
-
ctx.ui.notify(`Blocked write to protected path: ${path}`, 'warning');
|
|
24
|
-
}
|
|
25
|
-
return { block: true, reason: `Path "${path}" is protected` };
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
return undefined;
|
|
29
|
-
});
|
|
30
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Protected Paths Extension
|
|
3
|
+
*
|
|
4
|
+
* Blocks write and edit operations to protected paths.
|
|
5
|
+
* Useful for preventing accidental modifications to sensitive files.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import type { ExtensionAPI } from 'shortcutxl';
|
|
9
|
+
|
|
10
|
+
export default function (shortcut: ExtensionAPI) {
|
|
11
|
+
const protectedPaths = ['.env', '.git/', 'node_modules/'];
|
|
12
|
+
|
|
13
|
+
shortcut.on('tool_call', async (event, ctx) => {
|
|
14
|
+
if (event.toolName !== 'write' && event.toolName !== 'edit') {
|
|
15
|
+
return undefined;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
const path = event.input.path as string;
|
|
19
|
+
const isProtected = protectedPaths.some((p) => path.includes(p));
|
|
20
|
+
|
|
21
|
+
if (isProtected) {
|
|
22
|
+
if (ctx.hasUI) {
|
|
23
|
+
ctx.ui.notify(`Blocked write to protected path: ${path}`, 'warning');
|
|
24
|
+
}
|
|
25
|
+
return { block: true, reason: `Path "${path}" is protected` };
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
return undefined;
|
|
29
|
+
});
|
|
30
|
+
}
|
|
@@ -1,122 +1,122 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Q&A extraction extension - extracts questions from assistant responses
|
|
3
|
-
*
|
|
4
|
-
* Demonstrates the "prompt generator" pattern:
|
|
5
|
-
* 1. /qna command gets the last assistant message
|
|
6
|
-
* 2. Shows a spinner while extracting (hides editor)
|
|
7
|
-
* 3. Loads the result into the editor for user to fill in answers
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
import type { ExtensionAPI } from 'shortcutxl';
|
|
11
|
-
import { BorderedLoader, complete, type UserMessage } from 'shortcutxl';
|
|
12
|
-
|
|
13
|
-
const SYSTEM_PROMPT = `You are a question extractor. Given text from a conversation, extract any questions that need answering and format them for the user to fill in.
|
|
14
|
-
|
|
15
|
-
Output format:
|
|
16
|
-
- List each question on its own line, prefixed with "Q: "
|
|
17
|
-
- After each question, add a blank line for the answer prefixed with "A: "
|
|
18
|
-
- If no questions are found, output "No questions found in the last message."
|
|
19
|
-
|
|
20
|
-
Example output:
|
|
21
|
-
Q: What is your preferred database?
|
|
22
|
-
A:
|
|
23
|
-
|
|
24
|
-
Q: Should we use TypeScript or JavaScript?
|
|
25
|
-
A:
|
|
26
|
-
|
|
27
|
-
Keep questions in the order they appeared. Be concise.`;
|
|
28
|
-
|
|
29
|
-
export default function (shortcut: ExtensionAPI) {
|
|
30
|
-
shortcut.registerCommand('qna', {
|
|
31
|
-
description: 'Extract questions from last assistant message into editor',
|
|
32
|
-
handler: async (_args, ctx) => {
|
|
33
|
-
if (!ctx.hasUI) {
|
|
34
|
-
ctx.ui.notify('qna requires interactive mode', 'error');
|
|
35
|
-
return;
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
if (!ctx.model) {
|
|
39
|
-
ctx.ui.notify('No model selected', 'error');
|
|
40
|
-
return;
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
// Find the last assistant message on the current branch
|
|
44
|
-
const branch = ctx.sessionManager.getBranch();
|
|
45
|
-
let lastAssistantText: string | undefined;
|
|
46
|
-
|
|
47
|
-
for (let i = branch.length - 1; i >= 0; i--) {
|
|
48
|
-
const entry = branch[i];
|
|
49
|
-
if (entry.type === 'message') {
|
|
50
|
-
const msg = entry.message;
|
|
51
|
-
if ('role' in msg && msg.role === 'assistant') {
|
|
52
|
-
if (msg.stopReason !== 'stop') {
|
|
53
|
-
ctx.ui.notify(`Last assistant message incomplete (${msg.stopReason})`, 'error');
|
|
54
|
-
return;
|
|
55
|
-
}
|
|
56
|
-
const textParts = msg.content
|
|
57
|
-
.filter((c): c is { type: 'text'; text: string } => c.type === 'text')
|
|
58
|
-
.map((c) => c.text);
|
|
59
|
-
if (textParts.length > 0) {
|
|
60
|
-
lastAssistantText = textParts.join('\n');
|
|
61
|
-
break;
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
if (!lastAssistantText) {
|
|
68
|
-
ctx.ui.notify('No assistant messages found', 'error');
|
|
69
|
-
return;
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
// Run extraction with loader UI
|
|
73
|
-
const result = await ctx.ui.custom<string | null>((tui, theme, _kb, done) => {
|
|
74
|
-
const loader = new BorderedLoader(
|
|
75
|
-
tui,
|
|
76
|
-
theme,
|
|
77
|
-
`Extracting questions using ${ctx.model!.id}...`
|
|
78
|
-
);
|
|
79
|
-
loader.onAbort = () => done(null);
|
|
80
|
-
|
|
81
|
-
// Do the work
|
|
82
|
-
const doExtract = async () => {
|
|
83
|
-
const apiKey = await ctx.modelRegistry.getApiKey(ctx.model!);
|
|
84
|
-
const userMessage: UserMessage = {
|
|
85
|
-
role: 'user',
|
|
86
|
-
content: [{ type: 'text', text: lastAssistantText! }],
|
|
87
|
-
timestamp: Date.now()
|
|
88
|
-
};
|
|
89
|
-
|
|
90
|
-
const response = await complete(
|
|
91
|
-
ctx.model!,
|
|
92
|
-
{ systemPrompt: SYSTEM_PROMPT, messages: [userMessage] },
|
|
93
|
-
{ apiKey, signal: loader.signal }
|
|
94
|
-
);
|
|
95
|
-
|
|
96
|
-
if (response.stopReason === 'aborted') {
|
|
97
|
-
return null;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
return response.content
|
|
101
|
-
.filter((c): c is { type: 'text'; text: string } => c.type === 'text')
|
|
102
|
-
.map((c) => c.text)
|
|
103
|
-
.join('\n');
|
|
104
|
-
};
|
|
105
|
-
|
|
106
|
-
doExtract()
|
|
107
|
-
.then(done)
|
|
108
|
-
.catch(() => done(null));
|
|
109
|
-
|
|
110
|
-
return loader;
|
|
111
|
-
});
|
|
112
|
-
|
|
113
|
-
if (result === null) {
|
|
114
|
-
ctx.ui.notify('Cancelled', 'info');
|
|
115
|
-
return;
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
ctx.ui.setEditorText(result);
|
|
119
|
-
ctx.ui.notify('Questions loaded. Edit and submit when ready.', 'info');
|
|
120
|
-
}
|
|
121
|
-
});
|
|
122
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Q&A extraction extension - extracts questions from assistant responses
|
|
3
|
+
*
|
|
4
|
+
* Demonstrates the "prompt generator" pattern:
|
|
5
|
+
* 1. /qna command gets the last assistant message
|
|
6
|
+
* 2. Shows a spinner while extracting (hides editor)
|
|
7
|
+
* 3. Loads the result into the editor for user to fill in answers
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
import type { ExtensionAPI } from 'shortcutxl';
|
|
11
|
+
import { BorderedLoader, complete, type UserMessage } from 'shortcutxl';
|
|
12
|
+
|
|
13
|
+
const SYSTEM_PROMPT = `You are a question extractor. Given text from a conversation, extract any questions that need answering and format them for the user to fill in.
|
|
14
|
+
|
|
15
|
+
Output format:
|
|
16
|
+
- List each question on its own line, prefixed with "Q: "
|
|
17
|
+
- After each question, add a blank line for the answer prefixed with "A: "
|
|
18
|
+
- If no questions are found, output "No questions found in the last message."
|
|
19
|
+
|
|
20
|
+
Example output:
|
|
21
|
+
Q: What is your preferred database?
|
|
22
|
+
A:
|
|
23
|
+
|
|
24
|
+
Q: Should we use TypeScript or JavaScript?
|
|
25
|
+
A:
|
|
26
|
+
|
|
27
|
+
Keep questions in the order they appeared. Be concise.`;
|
|
28
|
+
|
|
29
|
+
export default function (shortcut: ExtensionAPI) {
|
|
30
|
+
shortcut.registerCommand('qna', {
|
|
31
|
+
description: 'Extract questions from last assistant message into editor',
|
|
32
|
+
handler: async (_args, ctx) => {
|
|
33
|
+
if (!ctx.hasUI) {
|
|
34
|
+
ctx.ui.notify('qna requires interactive mode', 'error');
|
|
35
|
+
return;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
if (!ctx.model) {
|
|
39
|
+
ctx.ui.notify('No model selected', 'error');
|
|
40
|
+
return;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
// Find the last assistant message on the current branch
|
|
44
|
+
const branch = ctx.sessionManager.getBranch();
|
|
45
|
+
let lastAssistantText: string | undefined;
|
|
46
|
+
|
|
47
|
+
for (let i = branch.length - 1; i >= 0; i--) {
|
|
48
|
+
const entry = branch[i];
|
|
49
|
+
if (entry.type === 'message') {
|
|
50
|
+
const msg = entry.message;
|
|
51
|
+
if ('role' in msg && msg.role === 'assistant') {
|
|
52
|
+
if (msg.stopReason !== 'stop') {
|
|
53
|
+
ctx.ui.notify(`Last assistant message incomplete (${msg.stopReason})`, 'error');
|
|
54
|
+
return;
|
|
55
|
+
}
|
|
56
|
+
const textParts = msg.content
|
|
57
|
+
.filter((c): c is { type: 'text'; text: string } => c.type === 'text')
|
|
58
|
+
.map((c) => c.text);
|
|
59
|
+
if (textParts.length > 0) {
|
|
60
|
+
lastAssistantText = textParts.join('\n');
|
|
61
|
+
break;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
if (!lastAssistantText) {
|
|
68
|
+
ctx.ui.notify('No assistant messages found', 'error');
|
|
69
|
+
return;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
// Run extraction with loader UI
|
|
73
|
+
const result = await ctx.ui.custom<string | null>((tui, theme, _kb, done) => {
|
|
74
|
+
const loader = new BorderedLoader(
|
|
75
|
+
tui,
|
|
76
|
+
theme,
|
|
77
|
+
`Extracting questions using ${ctx.model!.id}...`
|
|
78
|
+
);
|
|
79
|
+
loader.onAbort = () => done(null);
|
|
80
|
+
|
|
81
|
+
// Do the work
|
|
82
|
+
const doExtract = async () => {
|
|
83
|
+
const apiKey = await ctx.modelRegistry.getApiKey(ctx.model!);
|
|
84
|
+
const userMessage: UserMessage = {
|
|
85
|
+
role: 'user',
|
|
86
|
+
content: [{ type: 'text', text: lastAssistantText! }],
|
|
87
|
+
timestamp: Date.now()
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
const response = await complete(
|
|
91
|
+
ctx.model!,
|
|
92
|
+
{ systemPrompt: SYSTEM_PROMPT, messages: [userMessage] },
|
|
93
|
+
{ apiKey, signal: loader.signal }
|
|
94
|
+
);
|
|
95
|
+
|
|
96
|
+
if (response.stopReason === 'aborted') {
|
|
97
|
+
return null;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return response.content
|
|
101
|
+
.filter((c): c is { type: 'text'; text: string } => c.type === 'text')
|
|
102
|
+
.map((c) => c.text)
|
|
103
|
+
.join('\n');
|
|
104
|
+
};
|
|
105
|
+
|
|
106
|
+
doExtract()
|
|
107
|
+
.then(done)
|
|
108
|
+
.catch(() => done(null));
|
|
109
|
+
|
|
110
|
+
return loader;
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
if (result === null) {
|
|
114
|
+
ctx.ui.notify('Cancelled', 'info');
|
|
115
|
+
return;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
ctx.ui.setEditorText(result);
|
|
119
|
+
ctx.ui.notify('Questions loaded. Edit and submit when ready.', 'info');
|
|
120
|
+
}
|
|
121
|
+
});
|
|
122
|
+
}
|