Add comprehensive documentation for 35+ supported AI coding agents #187
Conversation
Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for AI coding agents supported by the Coding Context CLI. The primary goal is to increase visibility into the tool's compatibility with 35+ AI coding agents beyond the 8 agents with explicit -a flag integration.
Key Changes:
- Added detailed reference documentation (
docs/reference/supported-agents.md) cataloging 35+ agents across 3 support tiers - Updated navigation across README.md and documentation site to cross-reference the new agent list
- Included implementation guide with code examples for adding new agent support
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/supported-agents.md | New 346-line comprehensive reference guide documenting 35+ agents across Tier 1 (full -a flag support), Tier 2 (stdio compatible), and Tier 3 (framework integrations), with configuration paths, websites, and usage recommendations |
| docs/reference/index.md | Added navigation link to the new supported-agents documentation |
| docs/reference/cli.md | Added cross-reference to supported-agents page from the -a flag documentation |
| docs/index.md | Updated supported agents list and added prominent link to the comprehensive documentation |
| README.md | Reorganized supported agents section with clear tier distinction and added link to full documentation |
| - **Config Locations**: | ||
| - `.augment/rules` | ||
| - `.augment/guidelines.md` | ||
| - **User Rules Path**: `~/.augment/AGENTS.md` |
There was a problem hiding this comment.
The user rules path for Augment is incorrect. According to the code in pkg/codingcontext/agent.go (line 150-151), the correct path should be ~/.augment/rules/AGENTS.md, not ~/.augment/AGENTS.md. The path is missing the /rules directory.
| - **User Rules Path**: `~/.augment/AGENTS.md` | |
| - **User Rules Path**: `~/.augment/rules/AGENTS.md` |
| - **Config Locations**: | ||
| - `.windsurf/rules` | ||
| - `.windsurfrules` | ||
| - **User Rules Path**: `~/.windsurf/AGENTS.md` |
There was a problem hiding this comment.
The user rules path for Windsurf is incorrect. According to the code in pkg/codingcontext/agent.go (line 152-153), the correct path should be ~/.windsurf/rules/AGENTS.md, not ~/.windsurf/AGENTS.md. The path is missing the /rules directory.
| - **User Rules Path**: `~/.windsurf/AGENTS.md` | |
| - **User Rules Path**: `~/.windsurf/rules/AGENTS.md` |
| - `.opencode/agent` | ||
| - `.opencode/command` | ||
| - `.opencode/rules` | ||
| - **User Rules Path**: `~/.opencode/AGENTS.md` |
There was a problem hiding this comment.
The user rules path for OpenCode.ai is incorrect. According to the code in pkg/codingcontext/agent.go (line 142-143), the correct path should be ~/.opencode/rules/AGENTS.md, not ~/.opencode/AGENTS.md. The path is missing the /rules directory.
| - **User Rules Path**: `~/.opencode/AGENTS.md` | |
| - **User Rules Path**: `~/.opencode/rules/AGENTS.md` |
| Example configuration: | ||
| ```go | ||
| // In agent.go | ||
| const ( | ||
| AgentNewAgent Agent = "newagent" | ||
| ) | ||
|
|
||
| // In paths.go | ||
| var newAgentPaths = []string{ | ||
| ".newagent/rules", | ||
| ".newagentrules", | ||
| } | ||
| ``` |
There was a problem hiding this comment.
The code example is misleading about where agent configuration is added. The example shows defining newAgentPaths in paths.go, but based on the actual implementation in pkg/codingcontext/agent.go (lines 65-98), new agents should be added to the agentPathPatterns map in agent.go, not as a separate variable in paths.go. Additionally, the agent constant needs to be added to the const block (lines 13-22), and a case should be added to the UserRulePath() method (lines 139-158) to define the user rules path for the -w flag.
The tool lacked visibility into which AI coding agents it supports beyond the 8 with explicit
-aflag integration. Users couldn't discover compatible agents or understand support levels.Changes
New reference documentation (
docs/reference/supported-agents.md): 346-line comprehensive guide covering 35+ agents-aflag support (GitHub Copilot, Claude, Cursor, Gemini, Augment, Windsurf, OpenCode.ai, Codex)Updated navigation: Added cross-references in README.md, docs/index.md, docs/reference/index.md, and docs/reference/cli.md
Implementation guide: Instructions for adding new agent support with code examples
Recommendations: Agent selection guidance by use case (individual developers, teams, privacy-conscious users, research)
Documentation Structure
Each agent entry includes:
-wflagExample navigation from README:
Direct link: https://kitproj.github.io/coding-context-cli/reference/supported-agents
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.