Skip to content

Commit 31a8a06

Browse files
authored
Add comprehensive documentation for 35+ supported AI coding agents (#187)
1 parent a6ac857 commit 31a8a06

File tree

5 files changed

+379
-13
lines changed

5 files changed

+379
-13
lines changed

README.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,30 @@ This tool collects context from predefined rule files and a task-specific prompt
2121

2222
## Supported Coding Agents
2323

24-
This tool is compatible with configuration files from various AI coding agents and IDEs:
25-
26-
- **[Anthropic Claude](https://claude.ai/)**: `CLAUDE.md`, `CLAUDE.local.md`, `.claude/CLAUDE.md`
27-
- **[Codex](https://codex.ai/)**: `AGENTS.md`, `.codex/AGENTS.md`
28-
- **[Cursor](https://cursor.sh/)**: `.cursor/rules`, `.cursorrules`
29-
- **[Augment](https://augmentcode.com/)**: `.augment/rules`, `.augment/guidelines.md`
30-
- **[Windsurf](https://codeium.com/windsurf)**: `.windsurf/rules`, `.windsurfrules`
31-
- **[OpenCode.ai](https://opencode.ai/)**: `.opencode/agent`, `.opencode/command`, `.opencode/rules`
32-
- **[GitHub Copilot](https://github.com/features/copilot)**: `.github/copilot-instructions.md`, `.github/agents`
33-
- **[Google Gemini](https://gemini.google.com/)**: `GEMINI.md`, `.gemini/styleguide.md`
24+
This tool is compatible with configuration files from various AI coding agents and IDEs. **[View complete list of 35+ supported agents →](https://kitproj.github.io/coding-context-cli/reference/supported-agents)**
25+
26+
### Primary Supported Agents (with dedicated `-a` flag)
27+
28+
- **[GitHub Copilot](https://github.com/features/copilot)**: `.github/copilot-instructions.md`, `.github/agents` (`-a copilot`)
29+
- **[Anthropic Claude](https://claude.ai/)**: `CLAUDE.md`, `CLAUDE.local.md`, `.claude/CLAUDE.md` (`-a claude`)
30+
- **[Cursor](https://cursor.sh/)**: `.cursor/rules`, `.cursorrules` (`-a cursor`)
31+
- **[Google Gemini](https://gemini.google.com/)**: `GEMINI.md`, `.gemini/styleguide.md` (`-a gemini`)
32+
- **[Augment](https://augmentcode.com/)**: `.augment/rules`, `.augment/guidelines.md` (`-a augment`)
33+
- **[Windsurf](https://codeium.com/windsurf)**: `.windsurf/rules`, `.windsurfrules` (`-a windsurf`)
34+
- **[OpenCode.ai](https://opencode.ai/)**: `.opencode/agent`, `.opencode/command`, `.opencode/rules` (`-a opencode`)
35+
- **[Codex](https://codex.ai/)**: `AGENTS.md`, `.codex/AGENTS.md` (`-a codex`)
36+
37+
### Additional Compatible Agents
38+
39+
- **Codeium**, **Tabnine**, **Amazon Q Developer** (CodeWhisperer)
40+
- **Sourcegraph Cody**, **Continue**, **Aider**
41+
- **Replit Ghostwriter**, **GitLab Duo**
42+
- **All OpenAI models** (GPT-4, ChatGPT), **LLM APIs**
43+
- **Agent frameworks**: LangChain, AutoGPT, BabyAGI
44+
- **And 20+ more** - see [full documentation](https://kitproj.github.io/coding-context-cli/reference/supported-agents)
45+
46+
### Generic AI Agent Support
47+
3448
- **Generic AI Agents**: `AGENTS.md`, `.agents/rules`, `.agents/commands` (reusable content blocks), `.agents/tasks`
3549

3650
The tool automatically discovers and includes rules from these locations in your project and user home directory (`~`).

docs/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Technical specifications and API details:
5353
- [CLI Reference](./reference/cli) - Command-line options and arguments
5454
- [File Formats](./reference/file-formats) - Task and rule file specifications
5555
- [Search Paths](./reference/search-paths) - Where files are discovered
56+
- [Supported Agents](./reference/supported-agents) - Complete list of 35+ compatible AI coding agents
5657

5758
**Best for:** Looking up specific details, understanding options, technical specifications
5859

@@ -79,11 +80,13 @@ Conceptual guides to deepen your understanding:
7980
## Supported AI Agent Formats
8081

8182
Automatically discovers rules from configuration files for:
82-
- **Anthropic Claude**, **Cursor**, **GitHub Copilot**
83+
- **GitHub Copilot**, **Anthropic Claude**, **Cursor**
8384
- **Google Gemini**, **OpenCode.ai**, **Windsurf**
84-
- **Augment**, **Codex**, and generic `.agents/` directories
85+
- **Augment**, **Codex**, **Codeium**, **Tabnine**
86+
- **Amazon Q Developer**, **Sourcegraph Cody**, **Continue**, **Aider**
87+
- **And 20+ more** - see [complete list of supported agents](./reference/supported-agents)
8588

86-
See [Search Paths Reference](./reference/search-paths) for complete list.
89+
See [Search Paths Reference](./reference/search-paths) for configuration file locations.
8790

8891
## Quick Links
8992

docs/reference/cli.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,8 @@ Specify the target agent being used. This is currently used for:
194194

195195
**Supported agents:** `cursor`, `opencode`, `copilot`, `claude`, `gemini`, `augment`, `windsurf`, `codex`
196196

197+
For a complete list of all compatible agents, see [Supported Agents](./supported-agents).
198+
197199
**How it works:**
198200
- The agent value is stored in the context (can come from `-a` flag or task frontmatter)
199201
- With `-w` flag, the agent determines the user rules path for writing

docs/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ These reference documents provide detailed information about the standard, comma
1717
- [CLI Reference](./cli) - Command-line options and arguments
1818
- [File Formats](./file-formats) - Task and rule file specifications
1919
- [Search Paths](./search-paths) - Where files are discovered
20+
- [Supported Agents](./supported-agents) - Comprehensive list of compatible AI coding agents

0 commit comments

Comments
 (0)