Skip to content

Latest commit

 

History

History
 
 

README.md

AI DevKit CLI

The command-line interface for AI DevKit — set up and manage AI-assisted development environments in your project.

npm version License: MIT

Features

  • 🎯 Phase-based Development — Structured templates for requirements, design, planning, implementation, testing, and more
  • 🤖 AI Environment Setup — One-command configuration for Cursor, Claude Code, Gemini CLI, and other agents
  • 🧠 Skill Management — Install and manage reusable AI skills from registries
  • 📝 Customizable Templates — Markdown-based templates with YAML frontmatter

Installation

# Run directly (no install needed)
npx ai-devkit init

# Or install globally
npm install -g ai-devkit

Quick Start

# Set up your project interactively
ai-devkit init

# Set up from template (no step-by-step prompts when template is complete)
ai-devkit init --template ./ai-devkit.init.yaml

This will:

  1. Create a .ai-devkit.json configuration file
  2. Set up your AI development environment (e.g., Cursor, Claude Code)
  3. Generate phase templates in docs/ai/

Common Commands

# Initialize project
ai-devkit init

# Initialize project from YAML/JSON template
ai-devkit init --template ./ai-devkit.init.yaml

# Add a development phase
ai-devkit phase requirements

# Install a skill
ai-devkit skill add <skill-registry> <skill-name>

# Store a memory
ai-devkit memory store

Template example:

version: 1
environments:
  - codex
  - claude
phases:
  - requirements
  - design
  - planning
  - implementation
  - testing
skills:
  - registry: codeaholicguy/ai-devkit
    skill: debug
  - registry: codeaholicguy/ai-devkit
    skill: memory

Documentation

📖 For the full user guide, workflow examples, and best practices, visit:

ai-devkit.com/docs

License

MIT