You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: web/content/docs/1-getting-started.md
+86-31Lines changed: 86 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,28 @@ description: Quick start guide for AI DevKit
4
4
order: 1
5
5
---
6
6
7
+
**AI DevKit** is a toolkit that helps you work more effectively with AI coding assistants like Cursor, Claude Code, Codex, Antigravity, OpenCode, GitHub Copilot, and more. It provides structured workflows, reusable commands, and memory features to make AI-assisted development more consistent and productive.
8
+
9
+
## Why AI DevKit?
10
+
11
+
When working with AI assistants, you often find yourself:
12
+
- Repeating the same instructions across sessions
13
+
- Losing context between conversations
14
+
- Struggling to maintain consistency across features
15
+
16
+
AI DevKit solves these problems by giving your AI assistant:
17
+
-**Structured workflows** — Consistent processes from requirements to deployment
18
+
-**Custom commands** — Reusable prompts tailored to your project
19
+
-**Long-term memory** — Rules and patterns that persist across sessions
20
+
-**Skills** — Community-contributed capabilities your AI can learn
21
+
22
+
## Prerequisites
23
+
24
+
Before you begin, make sure have:
25
+
-**Node.js** (version 18 or higher)
26
+
-**npm** or **npx** (comes with Node.js)
27
+
- An AI coding assistant (Cursor, Claude Code, Codex, Antigravity, OpenCode, GitHub Copilot, etc.)
28
+
7
29
## Installation
8
30
9
31
Install AI DevKit globally using npm:
@@ -12,61 +34,94 @@ Install AI DevKit globally using npm:
12
34
npm install -g ai-devkit
13
35
```
14
36
15
-
Or use it directly with npx:
37
+
Or use it directly with npx (no installation required):
16
38
17
39
```bash
18
40
npx ai-devkit init
19
41
```
20
42
21
43
## Initialize Your Project
22
44
23
-
In your project directory, run:
45
+
Navigate to your project directory and run:
24
46
25
47
```bash
26
48
ai-devkit init
27
49
```
28
50
29
-
This will:
30
-
- Create a `docs/ai/` directory structure for your development phases
31
-
- Set up phase templates for requirements, design, planning, implementation, testing, deployment, and monitoring
32
-
- Copy environment-specific rules for CursorAI or Claude Code
51
+
You'll be prompted to select which AI environments you use (Cursor, Claude Code, etc.). AI DevKit will then:
52
+
53
+
1.**Create documentation structure** — A `docs/ai/` directory with templates for each development phase
54
+
2.**Set up AI environment files** — Configuration and commands for your selected AI assistants
55
+
3.**Save your preferences** — Stored in `.ai-devkit.json` for future updates
33
56
34
57
## Project Structure
35
58
36
-
After initialization, you'll have:
59
+
After initialization, you'll have a structured documentation folder:
37
60
38
61
```
39
62
docs/ai/
40
-
├── requirements/ # Problem understanding and requirements
41
-
├── design/ # System architecture and design decisions
42
-
├── planning/ # Task breakdown and project planning
43
-
├── implementation/ # Implementation guides and notes
44
-
├── testing/ # Testing strategy and test cases
45
-
├── deployment/ # Deployment and infrastructure docs
46
-
└── monitoring/ # Monitoring and observability setup
63
+
├── requirements/ # What you're building and why
64
+
├── design/ # Architecture and technical decisions
65
+
├── planning/ # Task breakdown and timeline
66
+
├── implementation/ # Implementation notes and guides
67
+
├── testing/ # Test strategy and cases
68
+
├── deployment/ # Deployment procedures
69
+
└── monitoring/ # Monitoring and observability
47
70
```
48
71
49
-
## Using Commands
72
+
This structure helps you maintain documentation throughout your development lifecycle, giving your AI assistant the context it needs to help effectively.
73
+
74
+
## Using Slash Commands
75
+
76
+
AI DevKit installs **slash commands** into your AI editor. These are special prompts you type directly into your AI assistant's chat (not in your terminal).
50
77
51
-
AI DevKit provides helpful commands to guide your development workflow:
78
+
> **Note:** Slash commands like `/new-requirement` are used inside your AI editor (Cursor, Claude Code, etc.), not in the terminal. Terminal commands start with `ai-devkit`.
52
79
53
-
-`/new-requirement` - Start a new feature with structured documentation
0 commit comments