Skip to content

Commit 177404f

Browse files
committed
docs: update agent setup content
1 parent 9419d3a commit 177404f

1 file changed

Lines changed: 55 additions & 10 deletions

File tree

web/content/docs/9-agent-setup.md

Lines changed: 55 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: agent-setup
55
order: 10
66
---
77

8-
The `ai-devkit install` command applies your saved project configuration (`.ai-devkit.json`) to your workspace.
8+
The `ai-devkit install` command applies your saved project configuration (`.ai-devkit.json`) to your workspace.
99
It is the best command for repeatable setup, onboarding, and syncing agent files after configuration changes.
1010

1111
Before running these commands:
@@ -18,6 +18,7 @@ Use `ai-devkit init` when:
1818
- You are setting up AI DevKit in a project for the first time
1919
- You want interactive prompts to choose environments and phases
2020
- You want non-interactive bootstrap from a template file (`ai-devkit init --template`)
21+
- You want to install AI DevKit built-in skills (prompted interactively, or pass `--built-in` for CI)
2122

2223
Use `ai-devkit install` when:
2324
- `.ai-devkit.json` already exists
@@ -26,6 +27,34 @@ Use `ai-devkit install` when:
2627

2728
## Basic Usage
2829

30+
The simplest way to get started is the interactive setup. This walks you through choosing environments, phases, and built-in skills:
31+
32+
```bash
33+
ai-devkit init
34+
```
35+
36+
Once `.ai-devkit.json` exists in your project, apply or re-apply the setup with:
37+
38+
```bash
39+
ai-devkit install
40+
```
41+
42+
Use a non-default config file if your project stores AI DevKit config elsewhere:
43+
44+
```bash
45+
ai-devkit install --config ./.ai-devkit.team.json
46+
```
47+
48+
Overwrite existing install artifacts without extra prompts:
49+
50+
```bash
51+
ai-devkit install --overwrite
52+
```
53+
54+
### Template-based Setup
55+
56+
For repeatable, non-interactive setup, create a template file. This is useful for sharing a standard configuration across teams or running in CI.
57+
2958
Create a file named `fullstack-engineer.yaml` in your project root with this content:
3059

3160
```yaml
@@ -39,6 +68,8 @@ phases:
3968
- planning
4069
- implementation
4170
- testing
71+
paths:
72+
docs: docs/ai
4273
skills:
4374
- registry: codeaholicguy/ai-devkit
4475
skill: debug
@@ -52,30 +83,44 @@ Initialize from that template:
5283
ai-devkit init --template ./fullstack-engineer.yaml
5384
```
5485

55-
If `.ai-devkit.json` already exists in this project, apply setup with:
86+
Use a custom directory for AI documentation (default is `docs/ai`):
5687

5788
```bash
58-
ai-devkit install
89+
ai-devkit init --docs-dir ./ai-docs
5990
```
6091

61-
Use a non-default config file if your project stores AI DevKit config elsewhere:
92+
#### Adding MCP Servers to a Template
6293

63-
```bash
64-
ai-devkit install --config ./.ai-devkit.team.json
94+
Templates can also define [MCP servers](https://modelcontextprotocol.io/) that agents connect to for extended capabilities such as persistent memory or external tool access. Add a `mcpServers` section to your template:
95+
96+
```yaml
97+
mcpServers:
98+
memory:
99+
transport: stdio
100+
command: npx
101+
args:
102+
- "@ai-devkit/memory"
65103
```
66104
67-
Overwrite existing install artifacts without extra prompts:
105+
After running `ai-devkit init --template`, MCP server definitions are saved to `.ai-devkit.json`. Run `ai-devkit install` to generate the agent-specific MCP config files.
106+
107+
## Built-in Skills
108+
109+
When running `ai-devkit init` interactively (without a template), you are prompted to install AI DevKit's built-in skills. In non-interactive environments such as CI, pass `--built-in` to install them automatically:
68110

69111
```bash
70-
ai-devkit install --overwrite
112+
ai-devkit init --environment cursor,claude --all --built-in
71113
```
72114

115+
When using a template with a `skills` section, skills from the template are installed instead of the built-in prompt.
116+
73117
## What `ai-devkit install` Sets Up
74118

75119
Based on your configured environments, AI DevKit installs or updates files such as:
76120
- `AGENTS.md` or `CLAUDE.md`
77121
- Environment command folders (for example `.cursor/commands/`, `.claude/commands/`, `.codex/commands/`)
78122
- Agent skill files (for example `.cursor/skills/`, `.claude/skills/`, `.agents/skills/` for Codex, and `.agent/skills/` for Antigravity)
123+
- MCP server configuration files for supported environments
79124
- Other environment-specific templates defined by AI DevKit
80125

81126
The exact artifacts depend on the environments configured in `.ai-devkit.json`.
@@ -90,7 +135,7 @@ The exact artifacts depend on the environments configured in `.ai-devkit.json`.
90135
ai-devkit init
91136
```
92137

93-
Or initialize deterministically from template:
138+
Or initialize deterministically from a template:
94139

95140
```bash
96141
ai-devkit init --template ./fullstack-engineer.yaml
@@ -118,7 +163,7 @@ ai-devkit init
118163

119164
This creates the configuration file used by `install`.
120165

121-
If you prefer non-interactive setup, use the template command shown in Basic Usage.
166+
If you prefer non-interactive setup, use the template command shown in [Template-based Setup](#template-based-setup).
122167

123168
### Existing files are not updated
124169

0 commit comments

Comments
 (0)