Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 24 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,30 @@ This tool collects context from predefined rule files and a task-specific prompt

## Supported Coding Agents

This tool is compatible with configuration files from various AI coding agents and IDEs:

- **[Anthropic Claude](https://claude.ai/)**: `CLAUDE.md`, `CLAUDE.local.md`, `.claude/CLAUDE.md`
- **[Codex](https://codex.ai/)**: `AGENTS.md`, `.codex/AGENTS.md`
- **[Cursor](https://cursor.sh/)**: `.cursor/rules`, `.cursorrules`
- **[Augment](https://augmentcode.com/)**: `.augment/rules`, `.augment/guidelines.md`
- **[Windsurf](https://codeium.com/windsurf)**: `.windsurf/rules`, `.windsurfrules`
- **[OpenCode.ai](https://opencode.ai/)**: `.opencode/agent`, `.opencode/command`, `.opencode/rules`
- **[GitHub Copilot](https://github.com/features/copilot)**: `.github/copilot-instructions.md`, `.github/agents`
- **[Google Gemini](https://gemini.google.com/)**: `GEMINI.md`, `.gemini/styleguide.md`
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)**

### Primary Supported Agents (with dedicated `-a` flag)

- **[GitHub Copilot](https://github.com/features/copilot)**: `.github/copilot-instructions.md`, `.github/agents` (`-a copilot`)
- **[Anthropic Claude](https://claude.ai/)**: `CLAUDE.md`, `CLAUDE.local.md`, `.claude/CLAUDE.md` (`-a claude`)
- **[Cursor](https://cursor.sh/)**: `.cursor/rules`, `.cursorrules` (`-a cursor`)
- **[Google Gemini](https://gemini.google.com/)**: `GEMINI.md`, `.gemini/styleguide.md` (`-a gemini`)
- **[Augment](https://augmentcode.com/)**: `.augment/rules`, `.augment/guidelines.md` (`-a augment`)
- **[Windsurf](https://codeium.com/windsurf)**: `.windsurf/rules`, `.windsurfrules` (`-a windsurf`)
- **[OpenCode.ai](https://opencode.ai/)**: `.opencode/agent`, `.opencode/command`, `.opencode/rules` (`-a opencode`)
- **[Codex](https://codex.ai/)**: `AGENTS.md`, `.codex/AGENTS.md` (`-a codex`)

### Additional Compatible Agents

- **Codeium**, **Tabnine**, **Amazon Q Developer** (CodeWhisperer)
- **Sourcegraph Cody**, **Continue**, **Aider**
- **Replit Ghostwriter**, **GitLab Duo**
- **All OpenAI models** (GPT-4, ChatGPT), **LLM APIs**
- **Agent frameworks**: LangChain, AutoGPT, BabyAGI
- **And 20+ more** - see [full documentation](https://kitproj.github.io/coding-context-cli/reference/supported-agents)

### Generic AI Agent Support

- **Generic AI Agents**: `AGENTS.md`, `.agents/rules`, `.agents/commands` (reusable content blocks), `.agents/tasks`

The tool automatically discovers and includes rules from these locations in your project and user home directory (`~`).
Expand Down
9 changes: 6 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Technical specifications and API details:
- [CLI Reference](./reference/cli) - Command-line options and arguments
- [File Formats](./reference/file-formats) - Task and rule file specifications
- [Search Paths](./reference/search-paths) - Where files are discovered
- [Supported Agents](./reference/supported-agents) - Complete list of 35+ compatible AI coding agents

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

Expand All @@ -78,11 +79,13 @@ Conceptual guides to deepen your understanding:
## Supported AI Agent Formats

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

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

## Quick Links

Expand Down
2 changes: 2 additions & 0 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,8 @@ Specify the target agent being used. This is currently used for:

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

For a complete list of all compatible agents, see [Supported Agents](./supported-agents).

**How it works:**
- The agent value is stored in the context (can come from `-a` flag or task frontmatter)
- With `-w` flag, the agent determines the user rules path for writing
Expand Down
1 change: 1 addition & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ These reference documents provide detailed information about command-line option
- [CLI Reference](./cli) - Command-line options and arguments
- [File Formats](./file-formats) - Task and rule file specifications
- [Search Paths](./search-paths) - Where files are discovered
- [Supported Agents](./supported-agents) - Comprehensive list of compatible AI coding agents
Loading