|
| 1 | +--- |
| 2 | +title: What is AI DevKit? |
| 3 | +description: An overview of AI DevKit, the open-source toolkit for structured, consistent AI-assisted software development. |
| 4 | +slug: what-is-ai-devkit |
| 5 | +order: 0 |
| 6 | +--- |
| 7 | + |
| 8 | +AI DevKit is an open-source toolkit that brings structure and consistency to AI-assisted software development. It works alongside AI coding assistants like Cursor, Claude Code, Codex, GitHub Copilot, Gemini CLI, and others, giving them the context, workflows, and memory they need to help you build software more effectively. |
| 9 | + |
| 10 | +## The Problem |
| 11 | + |
| 12 | +AI coding assistants are powerful, but using them day-to-day often feels inconsistent: |
| 13 | + |
| 14 | +- **Context is lost between sessions.** Your AI forgets past decisions, coding standards, and project conventions every time you start a new conversation. |
| 15 | +- **Workflows are ad hoc.** There's no standard way to move from requirements through design, implementation, and testing with AI assistance. |
| 16 | +- **Instructions are repeated constantly.** You re-explain the same rules, preferences, and patterns in every session. |
| 17 | +- **Knowledge stays siloed.** Lessons learned during development aren't captured in a way your AI assistant can reuse later. |
| 18 | + |
| 19 | +## How AI DevKit Helps |
| 20 | + |
| 21 | +AI DevKit addresses these gaps with four core capabilities: |
| 22 | + |
| 23 | +### Structured Development Workflows |
| 24 | + |
| 25 | +AI DevKit provides a complete set of slash commands that guide you and your AI through each phase of software development: |
| 26 | + |
| 27 | +- **Requirements** - Define what you're building and why |
| 28 | +- **Design** - Architect solutions with diagrams and technical decisions |
| 29 | +- **Planning** - Break work into actionable tasks |
| 30 | +- **Implementation** - Execute tasks step-by-step with AI guidance |
| 31 | +- **Testing** - Generate tests and validate your code |
| 32 | +- **Code Review** - Review changes before committing |
| 33 | + |
| 34 | +These workflows generate documentation in a `docs/ai/` directory inside your project, so your AI always has up-to-date project context. |
| 35 | + |
| 36 | +### Long-Term Memory |
| 37 | + |
| 38 | +The [Memory](/docs/6-memory) service gives your AI assistant persistent, local storage for coding standards, patterns, and project-specific knowledge. Once stored, this knowledge is automatically available in future sessions, so your AI never makes the same mistake twice. |
| 39 | + |
| 40 | +- 100% local storage (SQLite), no data leaves your machine |
| 41 | +- Scoped by project, repository, or global |
| 42 | +- Accessible via MCP (Model Context Protocol), CLI, or skills |
| 43 | + |
| 44 | +### Skills System |
| 45 | + |
| 46 | +[Skills](/docs/7-skills) are community-driven plugins that teach your AI new capabilities. Install a skill, and your agent immediately gains specialized knowledge, from frontend design patterns to database optimization to security best practices. |
| 47 | + |
| 48 | +- Install from community registries with one command |
| 49 | +- Create and share your own skills |
| 50 | +- Automatically available to all configured AI environments |
| 51 | + |
| 52 | +### Multi-Agent Support |
| 53 | + |
| 54 | +AI DevKit isn't tied to a single tool. It supports [many AI coding environments](/docs/2-supported-agents) and sets up the right configuration files, commands, and instructions for each one. Switch between agents or use multiple at the same time. Your workflows, memory, and skills carry across all of them. |
| 55 | + |
| 56 | +## A Typical Workflow |
| 57 | + |
| 58 | +Here's what working with AI DevKit looks like in practice: |
| 59 | + |
| 60 | +1. Run `ai-devkit init` in your terminal to set up your project |
| 61 | +2. Open your AI editor and type `/new-requirement` |
| 62 | +3. Your AI walks you through defining requirements, designing a solution, and planning tasks |
| 63 | +4. Type `/execute-plan` to implement the feature step-by-step |
| 64 | +5. Use `/writing-test` to generate tests, then `/code-review` before committing |
| 65 | + |
| 66 | +Each step produces documentation in `docs/ai/` that gives your AI full context for the next step. |
| 67 | + |
| 68 | +## How It Works |
| 69 | + |
| 70 | +1. **Initialize** - Run `ai-devkit init` to set up your project with documentation templates and environment-specific configurations. |
| 71 | +2. **Develop** - Use slash commands like `/new-requirement` and `/execute-plan` inside your AI editor to work through structured workflows. |
| 72 | +3. **Remember** - Store important decisions and patterns in memory so they persist across sessions. |
| 73 | +4. **Extend** - Install skills to give your AI specialized knowledge for your stack and domain. |
| 74 | + |
| 75 | +## Who Is It For? |
| 76 | + |
| 77 | +- **Individual developers** who want more consistent and productive AI-assisted workflows |
| 78 | +- **Teams** that need shared coding standards and conventions enforced across AI sessions |
| 79 | +- **Open-source maintainers** who want contributors' AI assistants to follow project guidelines automatically |
| 80 | + |
| 81 | +## What's Next? |
| 82 | + |
| 83 | +- **[Getting Started](/docs/1-getting-started)** - Set up AI DevKit in your project |
| 84 | +- **[Supported Agents](/docs/2-supported-agents)** - See which AI tools are supported |
| 85 | +- **[Development with AI DevKit](/docs/3-development-with-ai-devkit)** - Learn the full development workflow |
| 86 | +- **[Memory](/docs/6-memory)** - Give your AI long-term memory |
0 commit comments