|
1 | 1 | # AI DevKit |
2 | 2 |
|
3 | | -A CLI toolkit for AI-assisted software development with structured phase templates and environment setup for Cursor and Claude Code. |
| 3 | +**The standard for AI-assisted software development.** |
4 | 4 |
|
5 | | -[](https://www.npmjs.com/package/ai-devkit) |
6 | | -[](https://opensource.org/licenses/MIT) |
7 | | - |
8 | | -## Features |
9 | | - |
10 | | -- 🎯 **Phase-based Development**: Structured templates for each stage of the software development lifecycle |
11 | | -- 🤖 **AI Environment Setup**: Automatic configuration for Cursor and Claude Code |
12 | | -- 📝 **Customizable Templates**: Markdown-based templates with YAML frontmatter |
13 | | -- 🚀 **Interactive CLI**: User-friendly prompts with flag override support |
14 | | -- ⚙️ **State Management**: Tracks initialized phases and configuration |
15 | | - |
16 | | -## Installation |
17 | | - |
18 | | -```bash |
19 | | -# Using npx (no installation needed) |
20 | | -npx ai-devkit init |
21 | | - |
22 | | -# Or install globally |
23 | | -npm install -g ai-devkit |
24 | | -``` |
25 | | - |
26 | | -## Quick Start |
27 | | - |
28 | | -Initialize AI DevKit in your project: |
29 | | - |
30 | | -```bash |
31 | | -# Interactive mode (recommended) |
32 | | -ai-devkit init |
33 | | - |
34 | | -# With flags |
35 | | -ai-devkit init --environment cursor --all |
36 | | - |
37 | | -# Initialize specific phases |
38 | | -ai-devkit init --phases requirements,design,planning |
39 | | -``` |
40 | | - |
41 | | -This will: |
42 | | -1. Create a `.ai-devkit.json` configuration file |
43 | | -2. Set up your AI development environment (Cursor/Claude Code) |
44 | | -3. Generate phase templates in `docs/ai/` |
| 5 | +AI DevKit is an open-source ecosystem designed to bridge the gap between human intent and AI execution. It provides a suite of tools that standardize how AI agents interact with codebases, manage context, and execute development workflows. |
45 | 6 |
|
46 | | -Detailed user guide can be found [here](https://ai-devkit.com/docs/). |
| 7 | +[](https://opensource.org/licenses/MIT) |
47 | 8 |
|
48 | | -## Available Phases |
| 9 | +## 🌟 Vision |
49 | 10 |
|
50 | | -- **Requirements**: Problem understanding, requirements gathering, and success criteria |
51 | | -- **Design**: System architecture, data models, and technical design (include mermaid diagrams for architecture/data flow) |
52 | | -- **Planning**: Task breakdown, milestones, and project timeline |
53 | | -- **Implementation**: Technical implementation notes and code guidelines |
54 | | -- **Testing**: Testing strategy, test cases, and quality assurance |
55 | | -- **Deployment**: Deployment process, infrastructure, and release procedures |
56 | | -- **Monitoring**: Monitoring strategy, metrics, alerts, and observability |
| 11 | +The capabilities of AI coding agents are growing exponentially, but they often struggle with: |
| 12 | +1. **Context**: Losing track of broad project requirements and architectural decisions. |
| 13 | +2. **Consistency**: Generating code that doesn't follow project-specific patterns. |
| 14 | +3. **Process**: coding without a structured plan, leading to "spaghetti code". |
57 | 15 |
|
58 | | -## Commands |
| 16 | +**AI DevKit** solves this by enforcing a **Phase-Based Development** lifecycle—ensuring agents follow the same rigorous engineering |
| 17 | +standards as senior developers: Requirements → Design → Planning → Implementation → Testing. |
59 | 18 |
|
60 | | -### `ai-devkit init` |
| 19 | +## 📦 Packages |
61 | 20 |
|
62 | | -Initialize AI DevKit in your project. |
| 21 | +AI DevKit is a monorepo containing multiple specialized tools: |
63 | 22 |
|
64 | | -**Options:** |
65 | | -- `-e, --environment <env>`: Specify environment (cursor|claude|both) |
66 | | -- `-a, --all`: Initialize all phases at once |
67 | | -- `-p, --phases <phases>`: Comma-separated list of specific phases |
| 23 | +### [🖥️ ai-devkit (CLI)](./packages/cli) |
| 24 | +The command-line interface that orchestrates the development lifecycle. |
| 25 | +- **Scaffold** structured documentation (Requirements, Design, Plan). |
| 26 | +- **Configure** environments for Cursor, Claude Code, and other agents. |
| 27 | +- **Manage** project state and development phases. |
68 | 28 |
|
69 | | -**Examples:** |
70 | | -```bash |
71 | | -# Interactive mode |
72 | | -ai-devkit init |
| 29 | +[**Explore the CLI Docs →**](./packages/cli/README.md) |
73 | 30 |
|
74 | | -# Initialize for Cursor with all phases |
75 | | -ai-devkit init --environment cursor --all |
| 31 | +### [🧠 @ai-devkit/memory](./packages/memory) |
| 32 | +A lightweight MCP-based memory service that gives agents persistent, searchable long-term memory. |
| 33 | +- **Store** architectural decisions and coding patterns. |
| 34 | +- **Search** documentation and knowledge using full-text search. |
| 35 | +- **Share** context across different agents and sessions. |
76 | 36 |
|
77 | | -# Initialize specific phases |
78 | | -ai-devkit init --phases requirements,design,implementation |
79 | | -``` |
| 37 | +[**Explore the Memory Docs →**](./packages/memory/README.md) |
80 | 38 |
|
81 | | -### `ai-devkit phase [name]` |
| 39 | +## 🚀 Quick Start |
82 | 40 |
|
83 | | -Add or update a specific phase template. |
| 41 | +To start using the core toolkit in your project instantly: |
84 | 42 |
|
85 | | -**Examples:** |
86 | 43 | ```bash |
87 | | -# Interactive selection |
88 | | -ai-devkit phase |
89 | | - |
90 | | -# Add specific phase |
91 | | -ai-devkit phase requirements |
92 | | -ai-devkit phase testing |
93 | | -``` |
94 | | - |
95 | | -## Generated Structure |
96 | | - |
97 | | -After initialization, your project will have: |
98 | | - |
99 | | -``` |
100 | | -your-project/ |
101 | | -├── .ai-devkit.json # Configuration and state |
102 | | -├── docs/ |
103 | | -│ └── ai/ |
104 | | -│ ├── requirements/ |
105 | | -│ │ └── README.md |
106 | | -│ ├── design/ |
107 | | -│ │ └── README.md |
108 | | -│ ├── planning/ |
109 | | -│ │ └── README.md |
110 | | -│ ├── implementation/ |
111 | | -│ │ └── README.md |
112 | | -│ ├── testing/ |
113 | | -│ │ └── README.md |
114 | | -│ ├── deployment/ |
115 | | -│ │ └── README.md |
116 | | -│ └── monitoring/ |
117 | | -│ └── README.md |
118 | | -└── [Environment-specific files] |
119 | | -``` |
120 | | - |
121 | | -Supported Tools & Agents: |
122 | | -| Agent | Support | Notes | |
123 | | -|-----------------------------------------------------------|---------|---------------------------------------------------| |
124 | | -| [Claude Code](https://www.anthropic.com/claude-code) | ✅ | | |
125 | | -| [GitHub Copilot](https://code.visualstudio.com/) | ✅ | VSCode only | |
126 | | -| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | ✅ | | |
127 | | -| [Cursor](https://cursor.sh/) | ✅ | | |
128 | | -| [opencode](https://opencode.ai/) | ✅ | | |
129 | | -| [Antigravity](https://antigravity.google/) | ✅ | | |
130 | | -| [Windsurf](https://windsurf.com/) | 🚧 | Testing | |
131 | | -| [Kilo Code](https://github.com/Kilo-Org/kilocode) | 🚧 | Testing | |
132 | | -| [Roo Code](https://roocode.com/) | 🚧 | Testing | |
133 | | -| [Codex CLI](https://github.com/openai/codex) | 🚧 | Testing | |
134 | | -| [Amp](https://ampcode.com/) | 🚧 | Testing | |
135 | | - |
136 | | -Templates are designed to provide structure while remaining concise and AI-friendly. |
137 | | - |
138 | | -## Environment Setup |
139 | | - |
140 | | -### Cursor |
141 | | - |
142 | | -Generated files: |
143 | | -- `.cursor/rules/`: Project-specific rules as Markdown files (per [Cursor documentation](https://cursor.com/docs/context/rules)) |
144 | | -- `.cursor/commands/`: Custom slash commands as Markdown files (per [Cursor documentation](https://cursor.com/docs/agent/chat/commands)) |
145 | | - |
146 | | -Available slash commands: |
147 | | -- `/new-requirement`: Complete workflow for adding a new feature from requirements to PR |
148 | | -- `/code-review`: Structured local code review against design docs before pushing changes |
149 | | -- `/execute-plan`: Walk a feature plan task-by-task with interactive prompts |
150 | | -- `/writing-test`: Write unit/integration tests targeting 100% coverage |
151 | | -- `/update-planning`: Update planning and task breakdown |
152 | | -- `/check-implementation`: Compare implementation with design |
153 | | -- `/review-design`: Review system design and architecture |
154 | | -- `/review-requirements`: Review and summarize requirements |
155 | | - |
156 | | -Each command is stored as a plain Markdown file in `.cursor/commands/` and will automatically appear when you type `/` in Cursor's chat input. |
157 | | - |
158 | | -### Claude Code |
159 | | - |
160 | | -Generated files: |
161 | | -- `.claude/CLAUDE.md`: Workspace configuration and guidelines |
162 | | -- `.claude/commands/`: Custom commands as Markdown files |
163 | | - |
164 | | -Available commands: |
165 | | -- `new-requirement` - Complete workflow for adding a new feature from requirements to PR |
166 | | -- `code-review` - Structured local code review against design docs before pushing changes |
167 | | -- `execute-plan` - Walk a feature plan task-by-task with interactive prompts |
168 | | -- `writing-test` - Write unit/integration tests targeting 100% coverage |
169 | | -- `update-planning` - Update planning and task breakdown |
170 | | -- `check-implementation` - Compare implementation with design |
171 | | -- `review-design` - Review system design and architecture |
172 | | -- `review-requirements` - Review and summarize requirements |
173 | | -- `capture-knowledge` - Analyze and explain code with recursive dependency analysis and Mermaid diagrams |
174 | | - |
175 | | -Commands can be referenced in Claude Code chats to guide AI assistance through your development phases. |
176 | | - |
177 | | -## Workflow Examples |
178 | | - |
179 | | -### Initial Project Setup |
180 | | - |
181 | | -1. **Initialize your project:** |
182 | | - ```bash |
183 | | - ai-devkit init |
184 | | - ``` |
185 | | - |
186 | | -2. **Start with requirements:** |
187 | | - - Fill out `docs/ai/requirements/README.md` |
188 | | - - Use your AI assistant to help clarify and document requirements |
189 | | - |
190 | | -3. **Design your system:** |
191 | | - - Complete `docs/ai/design/README.md` and feature-specific files |
192 | | - - Include mermaid diagrams for architecture, component interactions, and data flow |
193 | | - - Reference requirements when making design decisions |
194 | | - |
195 | | -4. **Plan your work:** |
196 | | - - Break down tasks in `docs/ai/planning/README.md` |
197 | | - - Estimate and prioritize |
198 | | - |
199 | | -5. **Implement with guidance:** |
200 | | - - Follow patterns in `docs/ai/implementation/README.md` |
201 | | - - Keep implementation notes updated |
202 | | - |
203 | | -6. **Test thoroughly:** |
204 | | - - Use `docs/ai/testing/README.md` as your testing guide |
205 | | - - Document test cases and results |
206 | | - |
207 | | -7. **Deploy confidently:** |
208 | | - - Follow deployment procedures in `docs/ai/deployment/README.md` |
209 | | - |
210 | | -8. **Monitor and iterate:** |
211 | | - - Set up monitoring per `docs/ai/monitoring/README.md` |
212 | | - |
213 | | -## Use Cases |
214 | | - |
215 | | -- **New Projects**: Scaffold complete development documentation |
216 | | -- **Existing Projects**: Add structured documentation gradually |
217 | | -- **Team Collaboration**: Share common development practices |
218 | | -- **AI Pair Programming**: Provide context for AI assistants |
219 | | -- **Knowledge Management**: Document decisions and patterns |
220 | | - |
221 | | -## Best Practices |
222 | | - |
223 | | -1. **Keep templates updated**: As your project evolves, update phase documentation |
224 | | -2. **Reference across phases**: Link requirements to design, design to implementation |
225 | | -3. **Use with AI assistants**: Templates are designed to work well with AI code assistants |
226 | | -4. **Customize for your needs**: Templates are starting points, not rigid requirements |
227 | | -5. **Track decisions**: Document architectural decisions and their rationale |
228 | | - |
229 | | -## Configuration File |
230 | | - |
231 | | -The `.ai-devkit.json` file tracks your setup: |
232 | | - |
233 | | -```json |
234 | | -{ |
235 | | - "version": "0.2.0", |
236 | | - "environment": "cursor", |
237 | | - "initializedPhases": ["requirements", "design", "planning"], |
238 | | - "createdAt": "2025-10-14T...", |
239 | | - "updatedAt": "2025-10-14T..." |
240 | | -} |
| 44 | +npx ai-devkit init |
241 | 45 | ``` |
242 | 46 |
|
243 | | -## Development |
244 | | - |
245 | | -To work on ai-devkit itself: |
| 47 | +This will launch the interactive setup wizard to configure your project for AI-assisted development. |
246 | 48 |
|
247 | | -```bash |
248 | | -# Clone the repository |
249 | | -git clone <repository-url> |
250 | | -cd ai-devkit |
251 | | - |
252 | | -# Install dependencies |
253 | | -npm install |
| 49 | +## 🤝 Contributing |
254 | 50 |
|
255 | | -# Run in development mode |
256 | | -npm run dev init |
| 51 | +We welcome contributions! Whether you're building a new agent integration, adding a memory adapter, or improving our templates. |
257 | 52 |
|
258 | | -# Build |
259 | | -npm run build |
| 53 | +### Development Setup |
260 | 54 |
|
261 | | -# Test locally |
262 | | -npm link |
263 | | -ai-devkit init |
264 | | -``` |
| 55 | +1. **Clone the repository**: |
| 56 | + ```bash |
| 57 | + git clone https://github.com/Codeaholicguy/ai-devkit.git |
| 58 | + cd ai-devkit |
| 59 | + ``` |
265 | 60 |
|
266 | | -> **Note:** `ai-devkit init` now ensures the current directory is a git repository. If git is available and the repo isn't initialized, it will run `git init` automatically. |
| 61 | +2. **Install dependencies**: |
| 62 | + ```bash |
| 63 | + npm install |
| 64 | + ``` |
267 | 65 |
|
268 | | -## Contributing |
| 66 | +3. **Build packages**: |
| 67 | + ```bash |
| 68 | + npm run build |
| 69 | + ``` |
269 | 70 |
|
270 | | -Contributions are welcome! Please feel free to submit issues and pull requests. |
| 71 | +We use a monorepo structure. Ensure all changes are covered by tests before submitting a PR. |
271 | 72 |
|
272 | 73 | ## License |
273 | 74 |
|
274 | 75 | MIT |
275 | 76 |
|
276 | | ---- |
277 | | - |
278 | | -**Happy building with AI! 🚀** |
279 | | - |
280 | | -## Quick Reference |
281 | | - |
282 | | -| Task | Command | |
283 | | -|------|---------| |
284 | | -| Initialize everything | `npx ai-devkit init --all` | |
285 | | -| Initialize for Cursor | `npx ai-devkit init --environment cursor` | |
286 | | -| Add specific phases | `npx ai-devkit init --phases requirements,design` | |
287 | | -| Add one phase later | `npx ai-devkit phase testing` | |
288 | | -| Guided feature workflow | `/new-requirement` (Cursor & Claude) | |
289 | | -| Execute feature plan | `/execute-plan` (Cursor & Claude) | |
290 | | -| Generate tests | `/writing-test` (Cursor & Claude) | |
291 | | -| Local code review | `/code-review` (Cursor & Claude) | |
292 | | -| Help | `npx ai-devkit --help` | |
293 | | - |
294 | | -| Quick links | Description | |
295 | | -|-------------|-------------| |
296 | | -| [CHANGELOG.md](CHANGELOG.md) | Recent changes and release notes | |
297 | | -| [templates/](templates/) | Phase and environment templates | |
298 | | - |
0 commit comments