gm-copilot-cli 2.0.145 → 2.0.150
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/agents/gm.md +38 -0
- package/copilot-profile.md +1 -1
- package/hooks/pre-tool-use-hook.js +1 -1
- package/hooks/prompt-submit-hook.js +24 -117
- package/hooks/session-start-hook.js +5 -25
- package/manifest.yml +1 -1
- package/package.json +1 -1
- package/skills/code-search/SKILL.md +349 -5
- package/tools.json +1 -1
package/agents/gm.md
CHANGED
|
@@ -74,6 +74,44 @@ All execution via `bun x gm-exec` (Bash) or `agent-browser` skill. Every hypothe
|
|
|
74
74
|
|
|
75
75
|
**CODE YOUR HYPOTHESES**: Test every possible hypothesis using `bun x gm-exec` or `agent-browser` skill. Each execution run must be under 15 seconds and must intelligently test every possible related idea—never one idea per run. Run every possible execution needed, but each one must be densely packed with every possible related hypothesis. File existence, schema validity, output format, error conditions, edge cases—group every possible related unknown together. The goal is every possible hypothesis per run. Use `agent-browser` skill for cross-client UI testing and browser-based hypothesis validation.
|
|
76
76
|
|
|
77
|
+
**OPERATION CHAIN TESTING**: When analyzing or modifying systems with multi-step operation chains, decompose and test each part independently before testing the full chain. Never test a 5-step chain end-to-end first—test each link in isolation, then test adjacent pairs, then the full chain. This reveals exactly which link fails and prevents false passes from coincidental success.
|
|
78
|
+
|
|
79
|
+
Decomposition rules:
|
|
80
|
+
- Identify every distinct operation in the chain (input validation, API call, response parsing, state update, side effect, render)
|
|
81
|
+
- Test stateless operations in isolation first — they have no dependencies and confirm pure logic
|
|
82
|
+
- Test stateful operations together with their immediate downstream effect — they share a state boundary
|
|
83
|
+
- Bundle every confirmation that shares an assertion target into one run — same variable, same API call, same file = same run
|
|
84
|
+
- Unrelated assertion targets = separate runs
|
|
85
|
+
|
|
86
|
+
Tool selection per operation type:
|
|
87
|
+
- Pure logic (parse, validate, transform, calculate): `bun x gm-exec` — no DOM needed
|
|
88
|
+
- API call + response + error handling (node): `bun x gm-exec` — test all three in one run
|
|
89
|
+
- State mutation + downstream state effect: `bun x gm-exec` — test mutation and effect together
|
|
90
|
+
- DOM rendering, visual state, layout: `agent-browser` skill — requires real DOM
|
|
91
|
+
- User interaction (click, type, submit, navigate): `agent-browser` skill — requires real events
|
|
92
|
+
- State mutation visible on DOM: `agent-browser` skill — test both mutation and DOM effect in one session
|
|
93
|
+
- Error path on UI (spinner, toast, retry): `agent-browser` skill — test full visible error flow
|
|
94
|
+
|
|
95
|
+
PRE-EMIT-TEST (before editing any file):
|
|
96
|
+
1. Test current behavior on disk — understand what exists before changing it
|
|
97
|
+
2. Execute proposed logic in isolation via `bun x gm-exec` WITHOUT writing to any file
|
|
98
|
+
3. Confirm proposed approach produces correct output
|
|
99
|
+
4. Test failure paths of proposed approach
|
|
100
|
+
5. All mutables must resolve to KNOWN before EMIT phase opens
|
|
101
|
+
|
|
102
|
+
POST-EMIT-VALIDATION (immediately after writing files to disk):
|
|
103
|
+
1. Load the actual modified file from disk — not the in-memory version
|
|
104
|
+
2. Execute against real inputs with `bun x gm-exec` or `agent-browser` skill
|
|
105
|
+
3. Confirm the on-disk code behaves identically to what was proven in PRE-EMIT-TEST
|
|
106
|
+
4. Test all scenarios again on the real disk file — success, failure, edge cases
|
|
107
|
+
5. Any variance from PRE-EMIT-TEST results = regression, fix immediately before proceeding
|
|
108
|
+
|
|
109
|
+
Server + client split:
|
|
110
|
+
- Backend operations (node, API, DB, queue, file system): prove with `bun x gm-exec` first
|
|
111
|
+
- Frontend operations (DOM, forms, navigation, rendering): prove with `agent-browser` skill
|
|
112
|
+
- When a single feature spans server and client: run `bun x gm-exec` server tests AND `agent-browser` client tests — both required, neither substitutes for the other
|
|
113
|
+
- A server test passing does NOT prove the UI works. A browser test passing does NOT prove the backend handles edge cases.
|
|
114
|
+
|
|
77
115
|
**DEFAULT IS gm-exec**: `bun x gm-exec` is the primary execution tool. Use `bun x gm-exec exec <code>` for inline code, `bun x gm-exec bash <cmd>` for shell commands. Git is the only other allowed Bash command.
|
|
78
116
|
|
|
79
117
|
**TOOL POLICY**: All code execution via `bun x gm-exec`. Use `code-search` skill for exploration. Reference TOOL_INVARIANTS for enforcement.
|
package/copilot-profile.md
CHANGED
|
@@ -1,4 +1,9 @@
|
|
|
1
|
-
#!/usr/bin/env
|
|
1
|
+
#!/usr/bin/env bun
|
|
2
|
+
|
|
3
|
+
if (process.env.AGENTGUI_SUBPROCESS === '1') {
|
|
4
|
+
console.log(JSON.stringify({ additionalContext: '' }));
|
|
5
|
+
process.exit(0);
|
|
6
|
+
}
|
|
2
7
|
|
|
3
8
|
const fs = require('fs');
|
|
4
9
|
const path = require('path');
|
|
@@ -7,8 +12,8 @@ const { execSync } = require('child_process');
|
|
|
7
12
|
const pluginRoot = process.env.CLAUDE_PLUGIN_ROOT || process.env.GEMINI_PROJECT_DIR || process.env.OC_PLUGIN_ROOT || process.env.KILO_PLUGIN_ROOT || path.join(__dirname, '..');
|
|
8
13
|
const projectDir = process.env.CLAUDE_PROJECT_DIR || process.env.GEMINI_PROJECT_DIR || process.env.OC_PROJECT_DIR || process.env.KILO_PROJECT_DIR;
|
|
9
14
|
|
|
10
|
-
const COMPACT_CONTEXT = 'use gm agent | ref: TOOL_INVARIANTS | codesearch for exploration |
|
|
11
|
-
const PLAN_MODE_BLOCK = 'DO NOT use EnterPlanMode
|
|
15
|
+
const COMPACT_CONTEXT = 'use gm agent | ref: TOOL_INVARIANTS | codesearch for exploration | bun x gm-exec for execution';
|
|
16
|
+
const PLAN_MODE_BLOCK = 'DO NOT use EnterPlanMode. Use GM agent planning (PLAN→EXECUTE→EMIT→VERIFY→COMPLETE state machine) instead. Plan mode is blocked.';
|
|
12
17
|
|
|
13
18
|
const ensureGitignore = () => {
|
|
14
19
|
if (!projectDir) return;
|
|
@@ -25,102 +30,23 @@ const ensureGitignore = () => {
|
|
|
25
30
|
: content + '\n' + entry + '\n';
|
|
26
31
|
fs.writeFileSync(gitignorePath, newContent);
|
|
27
32
|
}
|
|
28
|
-
} catch (e) {
|
|
29
|
-
// Silently fail - not critical
|
|
30
|
-
}
|
|
31
|
-
};
|
|
32
|
-
|
|
33
|
-
const getBaseContext = (resetMsg = '') => {
|
|
34
|
-
let ctx = 'use gm agent';
|
|
35
|
-
if (resetMsg) ctx += ' - ' + resetMsg;
|
|
36
|
-
return ctx;
|
|
37
|
-
};
|
|
38
|
-
|
|
39
|
-
const readStdinPrompt = () => {
|
|
40
|
-
try {
|
|
41
|
-
const raw = fs.readFileSync(0, 'utf-8');
|
|
42
|
-
const data = JSON.parse(raw);
|
|
43
|
-
return data.prompt || '';
|
|
44
|
-
} catch (e) {
|
|
45
|
-
return '';
|
|
46
|
-
}
|
|
33
|
+
} catch (e) {}
|
|
47
34
|
};
|
|
48
35
|
|
|
49
|
-
const
|
|
50
|
-
if (!pluginRoot) return '';
|
|
51
|
-
try {
|
|
52
|
-
return fs.readFileSync(path.join(pluginRoot, 'agents/gm.md'), 'utf-8');
|
|
53
|
-
} catch (e) {
|
|
54
|
-
return '';
|
|
55
|
-
}
|
|
56
|
-
};
|
|
57
|
-
|
|
58
|
-
const runMcpThorns = () => {
|
|
36
|
+
const runThorns = () => {
|
|
59
37
|
if (!projectDir || !fs.existsSync(projectDir)) return '';
|
|
38
|
+
const localThorns = path.join(process.env.HOME || '/root', 'mcp-thorns', 'index.js');
|
|
39
|
+
const thornsBin = fs.existsSync(localThorns) ? `node ${localThorns}` : 'bun x mcp-thorns@latest';
|
|
60
40
|
try {
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
killSignal: 'SIGTERM'
|
|
69
|
-
});
|
|
70
|
-
} catch (bunErr) {
|
|
71
|
-
if (bunErr.killed && bunErr.signal === 'SIGTERM') {
|
|
72
|
-
thornOutput = '=== mcp-thorns ===\nSkipped (3min timeout)';
|
|
73
|
-
} else {
|
|
74
|
-
try {
|
|
75
|
-
thornOutput = execSync('npx -y mcp-thorns', {
|
|
76
|
-
encoding: 'utf-8',
|
|
77
|
-
stdio: ['pipe', 'pipe', 'pipe'],
|
|
78
|
-
cwd: projectDir,
|
|
79
|
-
timeout: 180000,
|
|
80
|
-
killSignal: 'SIGTERM'
|
|
81
|
-
});
|
|
82
|
-
} catch (npxErr) {
|
|
83
|
-
if (npxErr.killed && npxErr.signal === 'SIGTERM') {
|
|
84
|
-
thornOutput = '=== mcp-thorns ===\nSkipped (3min timeout)';
|
|
85
|
-
} else {
|
|
86
|
-
thornOutput = `=== mcp-thorns ===\nSkipped (error: ${bunErr.message.split('\n')[0]})`;
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
}
|
|
90
|
-
}
|
|
91
|
-
return `=== Repository analysis ===\n${thornOutput}`;
|
|
92
|
-
} catch (e) {
|
|
93
|
-
return `=== mcp-thorns ===\nSkipped (error: ${e.message.split('\n')[0]})`;
|
|
94
|
-
}
|
|
95
|
-
};
|
|
96
|
-
|
|
97
|
-
const runCodeSearch = (query, cwd) => {
|
|
98
|
-
if (!query || !cwd || !fs.existsSync(cwd)) return '';
|
|
99
|
-
try {
|
|
100
|
-
const escaped = query.replace(/"/g, '\\"').substring(0, 200);
|
|
101
|
-
let out;
|
|
102
|
-
try {
|
|
103
|
-
out = execSync(`bun x codebasesearch "${escaped}"`, {
|
|
104
|
-
encoding: 'utf-8',
|
|
105
|
-
stdio: ['pipe', 'pipe', 'pipe'],
|
|
106
|
-
cwd,
|
|
107
|
-
timeout: 55000,
|
|
108
|
-
killSignal: 'SIGTERM'
|
|
109
|
-
});
|
|
110
|
-
} catch (bunErr) {
|
|
111
|
-
if (bunErr.killed) return '';
|
|
112
|
-
out = execSync(`npx -y codebasesearch "${escaped}"`, {
|
|
113
|
-
encoding: 'utf-8',
|
|
114
|
-
stdio: ['pipe', 'pipe', 'pipe'],
|
|
115
|
-
cwd,
|
|
116
|
-
timeout: 55000,
|
|
117
|
-
killSignal: 'SIGTERM'
|
|
118
|
-
});
|
|
119
|
-
}
|
|
120
|
-
const lines = out.split('\n');
|
|
121
|
-
const resultStart = lines.findIndex(l => l.includes('Searching for:'));
|
|
122
|
-
return resultStart >= 0 ? lines.slice(resultStart).join('\n').trim() : out.trim();
|
|
41
|
+
const out = execSync(`${thornsBin} ${projectDir}`, {
|
|
42
|
+
encoding: 'utf-8',
|
|
43
|
+
stdio: ['pipe', 'pipe', 'pipe'],
|
|
44
|
+
timeout: 15000,
|
|
45
|
+
killSignal: 'SIGTERM'
|
|
46
|
+
});
|
|
47
|
+
return `=== mcp-thorns ===\n${out.trim()}`;
|
|
123
48
|
} catch (e) {
|
|
49
|
+
if (e.killed) return '=== mcp-thorns ===\nSkipped (timeout)';
|
|
124
50
|
return '';
|
|
125
51
|
}
|
|
126
52
|
};
|
|
@@ -141,31 +67,12 @@ const emit = (additionalContext) => {
|
|
|
141
67
|
|
|
142
68
|
try {
|
|
143
69
|
ensureGitignore();
|
|
144
|
-
|
|
145
|
-
const prompt = readStdinPrompt();
|
|
146
70
|
const parts = [];
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
if (gmContent) {
|
|
151
|
-
parts.push(gmContent);
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
const thornOutput = runMcpThorns();
|
|
155
|
-
parts.push(thornOutput);
|
|
156
|
-
|
|
157
|
-
// Always: base context and codebasesearch
|
|
158
|
-
parts.push(getBaseContext() + ' | ' + COMPACT_CONTEXT + ' | ' + PLAN_MODE_BLOCK);
|
|
159
|
-
|
|
160
|
-
if (prompt && projectDir) {
|
|
161
|
-
const searchResults = runCodeSearch(prompt, projectDir);
|
|
162
|
-
if (searchResults) {
|
|
163
|
-
parts.push(`=== Semantic code search results ===\n${searchResults}`);
|
|
164
|
-
}
|
|
165
|
-
}
|
|
166
|
-
|
|
71
|
+
const thorns = runThorns();
|
|
72
|
+
if (thorns) parts.push(thorns);
|
|
73
|
+
parts.push('use gm agent | ' + COMPACT_CONTEXT + ' | ' + PLAN_MODE_BLOCK);
|
|
167
74
|
emit(parts.join('\n\n'));
|
|
168
75
|
} catch (error) {
|
|
169
|
-
emit(
|
|
76
|
+
emit('use gm agent | hook error: ' + error.message);
|
|
170
77
|
process.exit(0);
|
|
171
78
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#!/usr/bin/env
|
|
1
|
+
#!/usr/bin/env bun
|
|
2
2
|
|
|
3
3
|
const fs = require('fs');
|
|
4
4
|
const path = require('path');
|
|
@@ -75,29 +75,13 @@ When exploring unfamiliar code, finding similar patterns, understanding integrat
|
|
|
75
75
|
encoding: 'utf-8',
|
|
76
76
|
stdio: ['pipe', 'pipe', 'pipe'],
|
|
77
77
|
cwd: projectDir,
|
|
78
|
-
timeout:
|
|
78
|
+
timeout: 15000,
|
|
79
79
|
killSignal: 'SIGTERM'
|
|
80
80
|
});
|
|
81
81
|
} catch (bunErr) {
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
try {
|
|
86
|
-
thornOutput = execSync(`npx -y mcp-thorns@latest`, {
|
|
87
|
-
encoding: 'utf-8',
|
|
88
|
-
stdio: ['pipe', 'pipe', 'pipe'],
|
|
89
|
-
cwd: projectDir,
|
|
90
|
-
timeout: 180000,
|
|
91
|
-
killSignal: 'SIGTERM'
|
|
92
|
-
});
|
|
93
|
-
} catch (npxErr) {
|
|
94
|
-
if (npxErr.killed && npxErr.signal === 'SIGTERM') {
|
|
95
|
-
thornOutput = '=== mcp-thorns ===\nSkipped (3min timeout)';
|
|
96
|
-
} else {
|
|
97
|
-
thornOutput = `=== mcp-thorns ===\nSkipped (error: ${bunErr.message.split('\n')[0]})`;
|
|
98
|
-
}
|
|
99
|
-
}
|
|
100
|
-
}
|
|
82
|
+
thornOutput = bunErr.killed
|
|
83
|
+
? '=== mcp-thorns ===\nSkipped (timeout)'
|
|
84
|
+
: `=== mcp-thorns ===\nSkipped (error: ${bunErr.message.split('\n')[0]})`;
|
|
101
85
|
}
|
|
102
86
|
outputs.push(`=== This is your initial insight of the repository, look at every possible aspect of this for initial opinionation and to offset the need for code exploration ===\n${thornOutput}`);
|
|
103
87
|
} catch (e) {
|
|
@@ -165,7 +149,3 @@ When exploring unfamiliar code, finding similar patterns, understanding integrat
|
|
|
165
149
|
|
|
166
150
|
|
|
167
151
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
package/manifest.yml
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,165 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: code-search
|
|
3
|
-
description: Semantic code search across the codebase. Use for all code exploration, finding implementations, locating files, and answering codebase questions.
|
|
3
|
+
description: Semantic code search across the codebase. Returns structured results with file paths, line numbers, and relevance scores. Use for all code exploration, finding implementations, locating files, and answering codebase questions.
|
|
4
|
+
category: exploration
|
|
4
5
|
allowed-tools: Bash(bun x codebasesearch*)
|
|
6
|
+
input-schema:
|
|
7
|
+
type: object
|
|
8
|
+
required: [prompt]
|
|
9
|
+
properties:
|
|
10
|
+
prompt:
|
|
11
|
+
type: string
|
|
12
|
+
minLength: 3
|
|
13
|
+
maxLength: 200
|
|
14
|
+
description: Natural language search query describing what you're looking for
|
|
15
|
+
context:
|
|
16
|
+
type: object
|
|
17
|
+
description: Optional context about search scope and restrictions
|
|
18
|
+
properties:
|
|
19
|
+
path:
|
|
20
|
+
type: string
|
|
21
|
+
description: Restrict search to this directory path (relative or absolute)
|
|
22
|
+
file-types:
|
|
23
|
+
type: array
|
|
24
|
+
items: { type: string }
|
|
25
|
+
description: Filter results by file extensions (e.g., ["js", "ts", "py"])
|
|
26
|
+
exclude-patterns:
|
|
27
|
+
type: array
|
|
28
|
+
items: { type: string }
|
|
29
|
+
description: Exclude paths matching glob patterns (e.g., ["node_modules", "*.test.js"])
|
|
30
|
+
filter:
|
|
31
|
+
type: object
|
|
32
|
+
description: Output filtering and formatting options
|
|
33
|
+
properties:
|
|
34
|
+
max-results:
|
|
35
|
+
type: integer
|
|
36
|
+
minimum: 1
|
|
37
|
+
maximum: 500
|
|
38
|
+
default: 50
|
|
39
|
+
description: Maximum number of results to return
|
|
40
|
+
min-score:
|
|
41
|
+
type: number
|
|
42
|
+
minimum: 0
|
|
43
|
+
maximum: 1
|
|
44
|
+
default: 0.5
|
|
45
|
+
description: Minimum relevance score (0-1) to include in results
|
|
46
|
+
sort-by:
|
|
47
|
+
type: string
|
|
48
|
+
enum: [relevance, path, line-number]
|
|
49
|
+
default: relevance
|
|
50
|
+
description: Result sort order
|
|
51
|
+
timeout:
|
|
52
|
+
type: integer
|
|
53
|
+
minimum: 1000
|
|
54
|
+
maximum: 30000
|
|
55
|
+
default: 10000
|
|
56
|
+
description: Search timeout in milliseconds (query returns partial results if exceeded)
|
|
57
|
+
output-schema:
|
|
58
|
+
type: object
|
|
59
|
+
required: [status, results, meta]
|
|
60
|
+
properties:
|
|
61
|
+
status:
|
|
62
|
+
type: string
|
|
63
|
+
enum: [success, partial, empty, timeout, error]
|
|
64
|
+
description: Overall operation status
|
|
65
|
+
results:
|
|
66
|
+
type: array
|
|
67
|
+
description: Array of matching code locations
|
|
68
|
+
items:
|
|
69
|
+
type: object
|
|
70
|
+
required: [file, line, content, score]
|
|
71
|
+
properties:
|
|
72
|
+
file:
|
|
73
|
+
type: string
|
|
74
|
+
description: Absolute or relative file path to matched file
|
|
75
|
+
line:
|
|
76
|
+
type: integer
|
|
77
|
+
description: Line number where match occurs (1-indexed)
|
|
78
|
+
content:
|
|
79
|
+
type: string
|
|
80
|
+
description: The matched line or context snippet
|
|
81
|
+
score:
|
|
82
|
+
type: number
|
|
83
|
+
minimum: 0
|
|
84
|
+
maximum: 1
|
|
85
|
+
description: Relevance score where 1.0 is perfect match
|
|
86
|
+
context:
|
|
87
|
+
type: object
|
|
88
|
+
description: Surrounding context lines (optional)
|
|
89
|
+
properties:
|
|
90
|
+
before:
|
|
91
|
+
type: array
|
|
92
|
+
items: { type: string }
|
|
93
|
+
description: Lines before the match
|
|
94
|
+
after:
|
|
95
|
+
type: array
|
|
96
|
+
items: { type: string }
|
|
97
|
+
description: Lines after the match
|
|
98
|
+
metadata:
|
|
99
|
+
type: object
|
|
100
|
+
description: File and match metadata (optional)
|
|
101
|
+
properties:
|
|
102
|
+
language:
|
|
103
|
+
type: string
|
|
104
|
+
description: Programming language detected (js, ts, py, rs, go, etc.)
|
|
105
|
+
size:
|
|
106
|
+
type: integer
|
|
107
|
+
description: File size in bytes
|
|
108
|
+
modified:
|
|
109
|
+
type: string
|
|
110
|
+
format: date-time
|
|
111
|
+
description: Last modification timestamp
|
|
112
|
+
meta:
|
|
113
|
+
type: object
|
|
114
|
+
required: [query, count, duration_ms]
|
|
115
|
+
description: Query execution metadata
|
|
116
|
+
properties:
|
|
117
|
+
query:
|
|
118
|
+
type: string
|
|
119
|
+
description: Normalized query that was executed
|
|
120
|
+
count:
|
|
121
|
+
type: integer
|
|
122
|
+
description: Total matches found (before filtering)
|
|
123
|
+
filtered:
|
|
124
|
+
type: integer
|
|
125
|
+
description: Results returned (after filtering and limiting)
|
|
126
|
+
duration_ms:
|
|
127
|
+
type: integer
|
|
128
|
+
description: Execution time in milliseconds
|
|
129
|
+
scanned_files:
|
|
130
|
+
type: integer
|
|
131
|
+
description: Total files examined during search
|
|
132
|
+
timestamp:
|
|
133
|
+
type: string
|
|
134
|
+
format: date-time
|
|
135
|
+
description: When execution completed
|
|
136
|
+
errors:
|
|
137
|
+
type: array
|
|
138
|
+
description: Non-fatal errors that occurred (may appear alongside partial results)
|
|
139
|
+
items:
|
|
140
|
+
type: object
|
|
141
|
+
properties:
|
|
142
|
+
code:
|
|
143
|
+
type: string
|
|
144
|
+
enum: [TIMEOUT, INVALID_PATH, SCHEMA_VIOLATION, EXECUTION_FAILED]
|
|
145
|
+
description: Error classification
|
|
146
|
+
message:
|
|
147
|
+
type: string
|
|
148
|
+
description: Human-readable error description
|
|
149
|
+
output-format: json
|
|
150
|
+
error-handling:
|
|
151
|
+
timeout:
|
|
152
|
+
behavior: return-partial
|
|
153
|
+
description: Returns results collected before timeout with status=partial
|
|
154
|
+
invalid-input:
|
|
155
|
+
behavior: reject
|
|
156
|
+
description: Returns status=error with validation errors in errors array
|
|
157
|
+
empty-results:
|
|
158
|
+
behavior: return-empty
|
|
159
|
+
description: Returns status=empty with count=0, filtered=0, results=[]
|
|
160
|
+
execution-error:
|
|
161
|
+
behavior: return-error
|
|
162
|
+
description: Returns status=error with error details in errors array
|
|
5
163
|
---
|
|
6
164
|
|
|
7
165
|
# Semantic Code Search
|
|
@@ -14,7 +172,56 @@ Only use bun x codebasesearch for searching code, or execute some custom code if
|
|
|
14
172
|
bun x codebasesearch "your natural language query"
|
|
15
173
|
```
|
|
16
174
|
|
|
17
|
-
## Examples
|
|
175
|
+
## Invocation Examples
|
|
176
|
+
|
|
177
|
+
### Via Skill Tool (Recommended - Structured JSON Input)
|
|
178
|
+
|
|
179
|
+
**Basic search**:
|
|
180
|
+
```json
|
|
181
|
+
{
|
|
182
|
+
"prompt": "where is authentication handled"
|
|
183
|
+
}
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
**With filtering and limits**:
|
|
187
|
+
```json
|
|
188
|
+
{
|
|
189
|
+
"prompt": "database connection setup",
|
|
190
|
+
"filter": {
|
|
191
|
+
"max-results": 20,
|
|
192
|
+
"min-score": 0.7,
|
|
193
|
+
"sort-by": "path"
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
**Scoped to directory with file type filter**:
|
|
199
|
+
```json
|
|
200
|
+
{
|
|
201
|
+
"prompt": "error logging middleware",
|
|
202
|
+
"context": {
|
|
203
|
+
"path": "src/middleware/",
|
|
204
|
+
"file-types": ["js", "ts"]
|
|
205
|
+
},
|
|
206
|
+
"timeout": 5000
|
|
207
|
+
}
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
**Exclude patterns and narrow results**:
|
|
211
|
+
```json
|
|
212
|
+
{
|
|
213
|
+
"prompt": "rate limiter implementation",
|
|
214
|
+
"context": {
|
|
215
|
+
"exclude-patterns": ["*.test.js", "node_modules/*"]
|
|
216
|
+
},
|
|
217
|
+
"filter": {
|
|
218
|
+
"max-results": 10,
|
|
219
|
+
"min-score": 0.8
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Legacy CLI Invocation (Still Supported)
|
|
18
225
|
|
|
19
226
|
```bash
|
|
20
227
|
bun x codebasesearch "where is authentication handled"
|
|
@@ -24,9 +231,146 @@ bun x codebasesearch "function that parses config files"
|
|
|
24
231
|
bun x codebasesearch "where is the rate limiter"
|
|
25
232
|
```
|
|
26
233
|
|
|
234
|
+
## Output Examples
|
|
235
|
+
|
|
236
|
+
### Success Response (Multiple Results)
|
|
237
|
+
|
|
238
|
+
```json
|
|
239
|
+
{
|
|
240
|
+
"status": "success",
|
|
241
|
+
"results": [
|
|
242
|
+
{
|
|
243
|
+
"file": "src/auth/handler.js",
|
|
244
|
+
"line": 42,
|
|
245
|
+
"content": "async function authenticateUser(credentials) {",
|
|
246
|
+
"score": 0.95,
|
|
247
|
+
"context": {
|
|
248
|
+
"before": [
|
|
249
|
+
"// Main authentication entry point",
|
|
250
|
+
""
|
|
251
|
+
],
|
|
252
|
+
"after": [
|
|
253
|
+
" const { username, password } = credentials;",
|
|
254
|
+
" const user = await db.users.findOne({ username });"
|
|
255
|
+
]
|
|
256
|
+
},
|
|
257
|
+
"metadata": {
|
|
258
|
+
"language": "javascript",
|
|
259
|
+
"size": 2048,
|
|
260
|
+
"modified": "2025-03-10T14:23:00Z"
|
|
261
|
+
}
|
|
262
|
+
},
|
|
263
|
+
{
|
|
264
|
+
"file": "src/middleware/auth-middleware.js",
|
|
265
|
+
"line": 18,
|
|
266
|
+
"content": "export const requireAuth = (req, res, next) => {",
|
|
267
|
+
"score": 0.78,
|
|
268
|
+
"metadata": {
|
|
269
|
+
"language": "javascript",
|
|
270
|
+
"size": 1024,
|
|
271
|
+
"modified": "2025-03-10T14:20:00Z"
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
],
|
|
275
|
+
"meta": {
|
|
276
|
+
"query": "authentication handled",
|
|
277
|
+
"count": 2,
|
|
278
|
+
"filtered": 2,
|
|
279
|
+
"duration_ms": 245,
|
|
280
|
+
"scanned_files": 87,
|
|
281
|
+
"timestamp": "2025-03-15T10:30:00Z"
|
|
282
|
+
}
|
|
283
|
+
}
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
### Empty Results Response
|
|
287
|
+
|
|
288
|
+
```json
|
|
289
|
+
{
|
|
290
|
+
"status": "empty",
|
|
291
|
+
"results": [],
|
|
292
|
+
"meta": {
|
|
293
|
+
"query": "nonexistent pattern xyz123",
|
|
294
|
+
"count": 0,
|
|
295
|
+
"filtered": 0,
|
|
296
|
+
"duration_ms": 123,
|
|
297
|
+
"scanned_files": 87,
|
|
298
|
+
"timestamp": "2025-03-15T10:30:00Z"
|
|
299
|
+
}
|
|
300
|
+
}
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### Timeout Response (Partial Results)
|
|
304
|
+
|
|
305
|
+
```json
|
|
306
|
+
{
|
|
307
|
+
"status": "partial",
|
|
308
|
+
"results": [
|
|
309
|
+
{
|
|
310
|
+
"file": "src/a.js",
|
|
311
|
+
"line": 5,
|
|
312
|
+
"content": "function init() {",
|
|
313
|
+
"score": 0.92,
|
|
314
|
+
"metadata": { "language": "javascript", "size": 512 }
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
"file": "src/b.js",
|
|
318
|
+
"line": 12,
|
|
319
|
+
"content": "const setup = () => {",
|
|
320
|
+
"score": 0.85,
|
|
321
|
+
"metadata": { "language": "javascript", "size": 768 }
|
|
322
|
+
}
|
|
323
|
+
],
|
|
324
|
+
"meta": {
|
|
325
|
+
"query": "expensive search pattern",
|
|
326
|
+
"count": 1847,
|
|
327
|
+
"filtered": 2,
|
|
328
|
+
"duration_ms": 10000,
|
|
329
|
+
"scanned_files": 45,
|
|
330
|
+
"timestamp": "2025-03-15T10:30:00Z"
|
|
331
|
+
},
|
|
332
|
+
"errors": [
|
|
333
|
+
{
|
|
334
|
+
"code": "TIMEOUT",
|
|
335
|
+
"message": "Search exceeded 10000ms limit. Returning partial results (2 of 1847 matches)."
|
|
336
|
+
}
|
|
337
|
+
]
|
|
338
|
+
}
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Error Response (Invalid Input)
|
|
342
|
+
|
|
343
|
+
```json
|
|
344
|
+
{
|
|
345
|
+
"status": "error",
|
|
346
|
+
"results": [],
|
|
347
|
+
"meta": {
|
|
348
|
+
"query": null,
|
|
349
|
+
"count": 0,
|
|
350
|
+
"filtered": 0,
|
|
351
|
+
"duration_ms": 50,
|
|
352
|
+
"scanned_files": 0,
|
|
353
|
+
"timestamp": "2025-03-15T10:30:00Z"
|
|
354
|
+
},
|
|
355
|
+
"errors": [
|
|
356
|
+
{
|
|
357
|
+
"code": "INVALID_PATH",
|
|
358
|
+
"message": "context.path='/nonexistent' does not exist"
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
"code": "SCHEMA_VIOLATION",
|
|
362
|
+
"message": "filter.max-results must be between 1 and 500, got 1000"
|
|
363
|
+
}
|
|
364
|
+
]
|
|
365
|
+
}
|
|
366
|
+
```
|
|
367
|
+
|
|
27
368
|
## Rules
|
|
28
369
|
|
|
29
370
|
- Always use this first before reading files — it returns file paths and line numbers
|
|
30
|
-
- Natural language queries work best; be descriptive
|
|
31
|
-
-
|
|
32
|
-
- Use
|
|
371
|
+
- Natural language queries work best; be descriptive about what you're looking for
|
|
372
|
+
- Structured JSON output includes relevance scores and file paths for immediate navigation
|
|
373
|
+
- Use returned file paths and line numbers to read full file context via Read tool
|
|
374
|
+
- Results are pre-sorted by relevance (highest scores first) unless sort-by specifies otherwise
|
|
375
|
+
- Timeout queries return partial results with status=partial — use if time-critical
|
|
376
|
+
- Schema validation ensures valid input before execution — invalid args return error with details
|