|
| 1 | +import type { AgentDefinition } from './types/agent-definition' |
| 2 | + |
| 3 | +const definition: AgentDefinition = { |
| 4 | + id: 'codebase-commands-explorer', |
| 5 | + displayName: 'Codebase Commands Explorer', |
| 6 | + publisher: 'james', |
| 7 | + model: 'openai/gpt-5', |
| 8 | + reasoningOptions: { |
| 9 | + enabled: true, |
| 10 | + effort: 'low', |
| 11 | + exclude: true, |
| 12 | + }, |
| 13 | + |
| 14 | + spawnerPrompt: `Analyzes any project's codebase to comprehensively discover all commands needed to build, test, and run the project. Provides detailed analysis of project structure, tech stack, and working commands with confidence scores.`, |
| 15 | + |
| 16 | + toolNames: ['spawn_agents', 'set_output'], |
| 17 | + spawnableAgents: [ |
| 18 | + 'codebuff/file-explorer@0.0.4', |
| 19 | + 'codebuff/read-only-commander-lite@0.0.1', |
| 20 | + ], |
| 21 | + |
| 22 | + inputSchema: { |
| 23 | + prompt: { |
| 24 | + type: 'string', |
| 25 | + description: |
| 26 | + 'Optional specific focus areas or requirements for the codebase analysis (e.g., "focus on test commands" or "include CI/CD analysis")', |
| 27 | + }, |
| 28 | + }, |
| 29 | + |
| 30 | + outputMode: 'structured_output', |
| 31 | + outputSchema: { |
| 32 | + type: 'object', |
| 33 | + properties: { |
| 34 | + projectOverview: { |
| 35 | + type: 'object', |
| 36 | + properties: { |
| 37 | + projectType: { |
| 38 | + type: 'string', |
| 39 | + description: |
| 40 | + 'Primary project type (e.g., Node.js, Python, Rust, Go, etc.)', |
| 41 | + }, |
| 42 | + techStack: { |
| 43 | + type: 'array', |
| 44 | + items: { type: 'string' }, |
| 45 | + description: 'List of technologies, frameworks, and tools detected', |
| 46 | + }, |
| 47 | + packageManagers: { |
| 48 | + type: 'array', |
| 49 | + items: { type: 'string' }, |
| 50 | + description: |
| 51 | + 'Package managers found (npm, yarn, pnpm, pip, cargo, etc.)', |
| 52 | + }, |
| 53 | + buildSystems: { |
| 54 | + type: 'array', |
| 55 | + items: { type: 'string' }, |
| 56 | + description: |
| 57 | + 'Build systems detected (webpack, vite, make, cmake, etc.)', |
| 58 | + }, |
| 59 | + keyFiles: { |
| 60 | + type: 'array', |
| 61 | + items: { type: 'string' }, |
| 62 | + description: 'Key configuration files found', |
| 63 | + }, |
| 64 | + }, |
| 65 | + required: [ |
| 66 | + 'projectType', |
| 67 | + 'techStack', |
| 68 | + 'packageManagers', |
| 69 | + 'buildSystems', |
| 70 | + 'keyFiles', |
| 71 | + ], |
| 72 | + }, |
| 73 | + workingCommands: { |
| 74 | + type: 'array', |
| 75 | + items: { |
| 76 | + type: 'object', |
| 77 | + properties: { |
| 78 | + command: { type: 'string', description: 'The working command' }, |
| 79 | + description: { |
| 80 | + type: 'string', |
| 81 | + description: 'What this command does', |
| 82 | + }, |
| 83 | + category: { |
| 84 | + type: 'string', |
| 85 | + enum: [ |
| 86 | + 'build', |
| 87 | + 'test', |
| 88 | + 'run', |
| 89 | + 'lint', |
| 90 | + 'format', |
| 91 | + 'install', |
| 92 | + 'clean', |
| 93 | + 'dev', |
| 94 | + ], |
| 95 | + description: 'Command category', |
| 96 | + }, |
| 97 | + confidenceScore: { |
| 98 | + type: 'number', |
| 99 | + minimum: 0, |
| 100 | + maximum: 1, |
| 101 | + description: 'Confidence that this command works (0-1)', |
| 102 | + }, |
| 103 | + workingDirectory: { |
| 104 | + type: 'string', |
| 105 | + description: 'Directory where command should be run', |
| 106 | + }, |
| 107 | + prerequisites: { |
| 108 | + type: 'array', |
| 109 | + items: { type: 'string' }, |
| 110 | + description: 'Commands that should be run first', |
| 111 | + }, |
| 112 | + environment: { |
| 113 | + type: 'string', |
| 114 | + description: 'Required environment or conditions', |
| 115 | + }, |
| 116 | + }, |
| 117 | + required: ['command', 'description', 'category', 'confidenceScore'], |
| 118 | + }, |
| 119 | + }, |
| 120 | + setupRequirements: { |
| 121 | + type: 'array', |
| 122 | + items: { |
| 123 | + type: 'object', |
| 124 | + properties: { |
| 125 | + requirement: { |
| 126 | + type: 'string', |
| 127 | + description: 'Setup requirement description', |
| 128 | + }, |
| 129 | + commands: { |
| 130 | + type: 'array', |
| 131 | + items: { type: 'string' }, |
| 132 | + description: 'Commands to fulfill this requirement', |
| 133 | + }, |
| 134 | + priority: { |
| 135 | + type: 'string', |
| 136 | + enum: ['critical', 'recommended', 'optional'], |
| 137 | + description: 'Priority level', |
| 138 | + }, |
| 139 | + }, |
| 140 | + required: ['requirement', 'commands', 'priority'], |
| 141 | + }, |
| 142 | + }, |
| 143 | + cicdAnalysis: { |
| 144 | + type: 'object', |
| 145 | + properties: { |
| 146 | + ciFilesFound: { |
| 147 | + type: 'array', |
| 148 | + items: { type: 'string' }, |
| 149 | + description: 'CI/CD configuration files detected', |
| 150 | + }, |
| 151 | + officialCommands: { |
| 152 | + type: 'array', |
| 153 | + items: { type: 'string' }, |
| 154 | + description: 'Commands found in CI/CD files', |
| 155 | + }, |
| 156 | + platforms: { |
| 157 | + type: 'array', |
| 158 | + items: { type: 'string' }, |
| 159 | + description: |
| 160 | + 'CI/CD platforms detected (GitHub Actions, GitLab CI, etc.)', |
| 161 | + }, |
| 162 | + }, |
| 163 | + required: ['ciFilesFound', 'officialCommands', 'platforms'], |
| 164 | + }, |
| 165 | + }, |
| 166 | + required: [ |
| 167 | + 'projectOverview', |
| 168 | + 'workingCommands', |
| 169 | + 'setupRequirements', |
| 170 | + 'cicdAnalysis', |
| 171 | + ], |
| 172 | + }, |
| 173 | + |
| 174 | + systemPrompt: `You are an expert codebase explorer that comprehensively analyzes any software project to discover all build, test, and run commands. You orchestrate multiple specialized agents to explore the project structure and test commands in parallel for maximum efficiency.`, |
| 175 | + |
| 176 | + instructionsPrompt: `Your mission is to provide a comprehensive analysis of any codebase to discover all working commands for building, testing, and running the project. |
| 177 | +
|
| 178 | +## Analysis Strategy: |
| 179 | +
|
| 180 | +1. **Project Structure Exploration**: First spawn file-explorer to understand the project layout, key files, and technology stack. |
| 181 | + In parallel, spawn a second file-explorer to learn about the build, lint, and testing processes across the codebase. |
| 182 | +
|
| 183 | +2. **Massive Parallel Command Testing**: Only after fully completing step 1 and getting back the results, spawn MANY (10-15) read-only-commander agents simultaneously to test different command combinations, including for any relevant sub-directories if this is a monorepo. |
| 184 | + Look for commands for the following project types: |
| 185 | + - Web apps: next.js, react, vue, etc. commands (build, test, start, dev, lint, etc.) |
| 186 | + - Node.js projects: npm/yarn/pnpm commands (build, test, start, dev, lint, etc.) |
| 187 | + - Python projects: pip, pytest, setup.py, tox commands |
| 188 | + - Rust projects: cargo commands (build, test, run, check, etc.) |
| 189 | + ...And so on for all project types |
| 190 | +
|
| 191 | + Include CI/CD Analysis: Have agents examine CI/CD files (.github/workflows, .gitlab-ci.yml, etc.) to discover official build processes |
| 192 | +
|
| 193 | +3. **Final Analysis**: Use the set_output tool to output the results of the analysis. Rate each working command based on: |
| 194 | + - Success rate of execution |
| 195 | + - Presence in official documentation/CI |
| 196 | + - Standard conventions for the project type |
| 197 | + - Output quality and expected behavior |
| 198 | +
|
| 199 | +## Command Categories to Test: |
| 200 | +- **install**: Dependency installation commands |
| 201 | +- **build**: Compilation and build commands |
| 202 | +- **test**: All types of testing (unit, integration, e2e) |
| 203 | +- **run**: Application execution commands |
| 204 | +- **dev**: Development server/watch commands |
| 205 | +- **lint**: Code linting and static analysis |
| 206 | +- **format**: Code formatting commands |
| 207 | +- **clean**: Cleanup and reset commands |
| 208 | +
|
| 209 | +## Be Extremely Thorough: |
| 210 | +- Try multiple package managers if multiple are detected |
| 211 | +- Test both short and long command forms |
| 212 | +- Check for custom scripts in package.json, Makefile, etc. |
| 213 | +- Test commands with different flags and options |
| 214 | +- Verify commands work from different directories |
| 215 | +- Check for environment-specific requirements |
| 216 | +
|
| 217 | +## Special Focus Areas: |
| 218 | +- Look for monorepo structures and workspace commands |
| 219 | +- Detect containerized setups and associated commands |
| 220 | +- Find database setup/migration commands |
| 221 | +- Identify development vs production commands |
| 222 | +- Discover deployment and release commands |
| 223 | +
|
| 224 | +Provide a comprehensive, structured output that gives developers everything they need to understand and work with the codebase immediately.`, |
| 225 | +} |
| 226 | + |
| 227 | +export default definition |
0 commit comments