You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8fb4dd5
Browse filesBrowse the repository at this point in the historyBrowse files
**Note**: Skip CLI checks for IDE-based agents (Copilot, Windsurf).
268
+
**Note**: CLI tool checks are now handled automatically based on the `requires_cli` field in AGENT_CONFIG. No additional code changes needed in the `check()` or `init()` commands - they automatically loop through AGENT_CONFIG and check tools as needed.
269
+
270
+
## Important Design Decisions
271
+
272
+
### Using Actual CLI Tool Names as Keys
273
+
274
+
**CRITICAL**: When adding a new agent to AGENT_CONFIG, always use the **actual executable name** as the dictionary key, not a shortened or convenient version.
275
+
276
+
**Why this matters:**
277
+
- The `check_tool()` function uses `shutil.which(tool)` to find executables in the system PATH
278
+
- If the key doesn't match the actual CLI tool name, you'll need special-case mappings throughout the codebase
279
+
- This creates unnecessary complexity and maintenance burden
5.**Help text inconsistency**: Update all user-facing text consistently
383
+
1.**Using shorthand keys instead of actual CLI tool names**: Always use the actual executable name as the AGENT_CONFIG key (e.g., `"cursor-agent"` not `"cursor"`). This prevents the need for special-case mappings throughout the codebase.
384
+
2.**Forgetting update scripts**: Both bash and PowerShell scripts must be updated when adding new agents.
385
+
3.**Incorrect `requires_cli` value**: Set to `True` only for agents that actually have CLI tools to check; set to `False` for IDE-based agents.
386
+
4.**Wrong argument format**: Use correct placeholder format for each agent type (`$ARGUMENTS` for Markdown, `{{args}}` for TOML).
Copy file name to clipboardExpand all lines: README.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,12 @@ Use `specifyplus` or `sp` commands instead of `specify`.
50
50
<strong>An effort to allow organizations to focus on product scenarios rather than writing undifferentiated code with the help of Spec-Driven Development.</strong>
@@ -199,6 +204,7 @@ Want to see Spec Kit in action? Watch our [video overview](https://www.youtube.c
0 commit comments