@@ -4,104 +4,111 @@ description: Environments supported by AI DevKit
44order : 2
55---
66
7- ## Supported Environments
7+ AI DevKit works with a variety of AI coding assistants. This page lists all supported environments and explains what AI DevKit provides for each one.
88
9- ### [ Cursor] ( https://cursor.com/ )
10- ** Status:** Ready
9+ ## Status Legend
10+
11+ | Status | Meaning |
12+ | --------| ---------|
13+ | ** Ready** | Fully supported and tested. Safe for production use. |
14+ | ** Experimental** | Works but may have issues. We're actively testing and improving support. |
15+
16+ ## Ready Environments
1117
18+ These environments are fully supported with stable integrations.
19+
20+ ### [ Cursor] ( https://cursor.com/ )
1221** What AI DevKit provides:**
13- - ` AGENTS.md ` - Agent instructions for [ Cursor] ( https://cursor.com/docs/context/rules )
14- - ` .cursor/commands/ ` - Custom [ slash commands] ( https://cursor.com/docs/context/commands ) for structured development workflows
15- - ` .cursor/rules/ ` - [ Editor rules] ( https://cursor.com/docs/context/rules ) for consistent coding standards
22+ - ` AGENTS.md ` — Agent instructions for [ Cursor] ( https://cursor.com/docs/context/rules )
23+ - ` .cursor/commands/ ` — Custom [ slash commands] ( https://cursor.com/docs/context/commands ) for structured development workflows
24+ - ` .cursor/rules/ ` — [ Editor rules] ( https://cursor.com/docs/context/rules ) for consistent coding standards
1625
1726### [ Claude Code] ( https://www.claude.com/product/claude-code )
18- ** Status:** Ready
19-
2027** What AI DevKit provides:**
21- - ` AGENTS.md ` - [ Claude workspace configuration] ( https://www.anthropic.com/engineering/claude-code-best-practices ) and context
22- - ` .claude/commands/ ` - Custom [ slash commands] ( https://code.claude.com/docs/en/slash-commands )
28+ - ` AGENTS.md ` — [ Claude workspace configuration] ( https://www.anthropic.com/engineering/claude-code-best-practices ) and context
29+ - ` .claude/commands/ ` — Custom [ slash commands] ( https://code.claude.com/docs/en/slash-commands )
2330
2431### [ GitHub Copilot] ( https://github.com/features/copilot )
25- ** Status:** Ready
26-
2732** What AI DevKit provides:**
28- - ` .github/prompts/ ` - GitHub Copilot [ custom prompts with VSCode] ( https://code.visualstudio.com/docs/copilot/customization/prompt-files )
29-
30- ### [ Google Gemini] ( https://geminicli.com/ )
31- ** Status:** Ready
33+ - ` .github/prompts/ ` — GitHub Copilot [ custom prompts with VSCode] ( https://code.visualstudio.com/docs/copilot/customization/prompt-files )
3234
35+ ### [ Google Gemini CLI] ( https://geminicli.com/ )
3336** What AI DevKit provides:**
34- - ` GEMINI.md ` - [ Context file] ( https://geminicli.com/docs/cli/gemini-md/ ) for providing instructional context to the Gemini model
35- - ` .gemini/commands/ ` - Gemini [ custom commands] ( https://geminicli.com/docs/cli/commands/ )
37+ - ` GEMINI.md ` — [ Context file] ( https://geminicli.com/docs/cli/gemini-md/ ) for providing instructional context to the Gemini model
38+ - ` .gemini/commands/ ` — Gemini [ custom commands] ( https://geminicli.com/docs/cli/commands/ )
3639
3740### [ OpenAI Codex] ( https://chatgpt.com/en-SE/features/codex )
38- In order to use Codex, you need to run ` ai-devkit setup --global ` .
41+ > ** Note:** Codex requires global setup because it reads commands from a system-wide location rather than your project directory.
42+ >
43+ > ``` bash
44+ > ai-devkit setup --global
45+ > ` ` `
3946
40- ** Status:** Ready
47+ ** What AI DevKit provides:**
48+ - ` AGENTS.md` — Codex-specific configuration and context
49+ - ` .codex/commands/` — Commands tailored for Codex' s code-focused capabilities
4150
51+ ### [OpenCode](https://opencode.ai/)
4252**What AI DevKit provides:**
43- - ` AGENTS.md ` - Codex-specific configuration and context
44- - ` .codex /commands/ ` - Commands tailored for Codex's code-focused capabilities
53+ - `AGENTS.md` — OpenCode [custom instructions](https://opencode.ai/docs/rules/)
54+ - `.opencode /commands/` — OpenCode [custom commands](https://opencode.ai/docs/commands/)
4555
46- ### [ Windsurf] ( https://windsurf.com/ )
47- ** Status:** Testing
56+ ### [Antigravity](https://antigravity.google/)
57+ > **Note:** Antigravity requires global setup.
58+ >
59+ > ```bash
60+ > ai-devkit setup --global
61+ > ```
4862
4963**What AI DevKit provides:**
50- - ` AGENTS.md ` - Windsurf environment configuration
51- - ` .windsurf/commands/ ` - Commands optimized for Windsurf's interface
64+ - `.agent/workflows/` — Workflow for [Antigravity](https://codelabs.developers.google.com/getting-started-google-antigravity#8)' s advanced features
5265
53- ### [ KiloCode] ( https://kilocode.ai/ )
54- ** Status:** Testing
66+ # # Experimental Environments
5567
56- ** What AI DevKit provides:**
57- - ` AGENTS.md ` - KiloCode configuration for large project handling
58- - ` .kilocode/commands/ ` - Commands designed for large-scale development
68+ These environments are under active development. They work, but you may encounter issues.
5969
60- ### [ AMP] ( https://ampcode.com/ )
61- ** Status:** Testing
70+ # ## [Windsurf](https://windsurf.com/)
6271
6372** What AI DevKit provides:**
64- - ` AGENTS.md ` - AMP configuration for accelerated workflows
65- - ` .agents /commands/ ` - Commands optimized for rapid development cycles
73+ - ` AGENTS.md` — Windsurf environment configuration
74+ - ` .windsurf /commands/` — Commands optimized for Windsurf ' s interface
6675
67- ### [ OpenCode] ( https://opencode.ai/ )
68- ** Status:** Ready
76+ ### [KiloCode](https://kilocode.ai/)
6977
7078**What AI DevKit provides:**
71- - ` AGENTS.md ` - OpenCode [ custom instructions ] ( https://opencode.ai/docs/rules/ )
72- - ` .opencode /commands/ ` - OpenCode [ custom commands ] ( https://opencode.ai/docs/commands/ )
79+ - `AGENTS.md` — KiloCode configuration for large project handling
80+ - `.kilocode /commands/` — Commands designed for large-scale development
7381
74- ### [ Roo Code] ( https://roocode.com/ )
75- ** Status:** Testing
82+ ### [AMP](https://ampcode.com/)
7683
7784**What AI DevKit provides:**
78- - ` AGENTS.md ` - Roo Code configuration and context
79- - ` .roo /commands/ ` - Commands optimized for Roo's advanced features
85+ - `AGENTS.md` — AMP configuration for accelerated workflows
86+ - `.agents /commands/` — Commands optimized for rapid development cycles
8087
81- ### [ Antigravity] ( https://antigravity.google/ )
82- ** Status:** Ready
88+ ### [Roo Code](https://roocode.com/)
8389
8490**What AI DevKit provides:**
85- - ` .agent/workflows/ ` - Workflow for [ Antigravity] ( https://codelabs.developers.google.com/getting-started-google-antigravity#8 ) 's advanced features
91+ - `AGENTS.md` — Roo Code configuration and context
92+ - `.roo/commands/` — Commands optimized for Roo' s advanced features
8693
8794# # Environment Setup
8895
8996# ## Interactive Multi-Selection
9097
91- When you run ` ai-devkit init ` , you can select multiple environments simultaneously :
98+ When you run ` ai-devkit init` , you can select multiple environments at once :
9299
93100` ` ` bash
94101ai-devkit init
95102` ` `
96103
97104This presents an interactive checklist where you can:
98- - Use spacebar to select/ deselect environments
99- - Press Enter to confirm your selections
100- - Choose any combination of the 10 supported environments
105+ - ** Spacebar ** — Select or deselect an environment
106+ - ** Enter** — Confirm your selections
107+ - Select any combination of the supported environments
101108
102109# ## Configuration Storage
103110
104- Your selections are stored in ` .ai-devkit.json ` :
111+ Your selections are saved in ` .ai-devkit.json` :
105112
106113` ` ` json
107114{
@@ -113,34 +120,36 @@ Your selections are stored in `.ai-devkit.json`:
113120}
114121` ` `
115122
116- ### Re-running Setup
123+ # ## Adding More Environments Later
117124
118- If you want to add more environments later :
125+ Want to add another environment after initial setup ? Just run :
119126
120127` ` ` bash
121128ai-devkit init
122129` ` `
123130
124131AI DevKit will:
125- 1 . Detect existing environments
126- 2 . Show confirmation prompts for overwriting
132+ 1. Detect your existing environments
133+ 2. Ask before overwriting any existing configurations
1271343. Add new environments alongside existing ones
128135
129136# ## Override Protection
130137
131- When re-running ` ai-devkit init ` , you'll be prompted before overwriting existing environment configurations :
138+ When re-running ` ai-devkit init` , you' ll see a warning before any existing files are overwritten :
132139
133140```
134141Warning: The following environments are already set up: cursor, claude
135142
136143Do you want to continue?
137144```
138145
139- ## Contributing New Environments
146+ ## For Contributors
147+
148+ Want to add support for a new AI environment? We welcome contributions!
140149
141- AI DevKit welcomes contributions for new AI development environments. To add support for a new environment:
150+ 1. **Create Environment Definition** — Add to `src/util/env.ts`
151+ 2. **Add Templates** — Create `templates/env/{code}/` directory
152+ 3. **Update Documentation** — Add to this guide
153+ 4. **Test Integration** — Ensure proper initialization and configuration
142154
143- 1 . ** Create Environment Definition** : Add to ` src/util/env.ts `
144- 2 . ** Add Templates** : Create ` templates/env/{code}/ ` directory
145- 3 . ** Update Documentation** : Add to this guide
146- 4 . ** Test Integration** : Ensure proper initialization and configuration
155+ See our [Contributing Guide](https://github.com/Codeaholicguy/ai-devkit/blob/main/CONTRIBUTING.md) for details.
0 commit comments