VibeKit VDK CLI

Stop Training Your AI Assistant Every Day

The world's first Vibe Development Kit - Train any AI coding assistant to understand your project like a senior developer who's been on your team for years.

VDK CLI revolutionizes AI-assisted development by generating intelligent rules that make AI suggestions 60% faster and perfectly matched to your codebase patterns. This tool helps developers create project-aware AI assistants and provides seamless integration across all major coding platforms.

Demo

Interactive Setup & Features

Quick Start Workflow

Features

Intelligent Project Analysis Automatically detects 20+ technologies, frameworks, and architectural patterns in your codebase

Universal AI Compatibility Works with Claude Code, Cursor, Windsurf, GitHub Copilot, and any AI coding assistant

Smart Rule Generation Creates tailored MDC files with project-specific patterns, conventions, and best practices

5-Minute Setup Zero configuration required - instant value with automatic project detection and rule deployment

Quick Start

Installation

# Install globally
npm install -g @vibe-dev-kit/cli

# Or use with pnpm
pnpm add -g @vibe-dev-kit/cli

# Or use the installer script
curl -fsSL https://raw.githubusercontent.com/entro314-labs/VibeKit-VDK-CLI/main/install.sh | sh

Basic Usage

# Initialize in your project
cd your-project
vdk init

# Interactive mode with guided setup
vdk init --interactive

# Check what VDK detected
vdk status

That's it! Your AI assistant now understands your project's patterns and conventions.

How It Works

1. Project Analysis: Scans your codebase to detect technologies, frameworks, and architectural patterns
2. Pattern Recognition: Identifies naming conventions, code structures, and project-specific practices
3. Rule Generation: Creates customized MDC files with intelligent guidelines for your tech stack
4. AI Integration: Deploys rules to your preferred AI assistant's configuration directory

Supported Technologies

Frontend Frameworks

Backend & Languages

AI Assistants

Build Tools & Services

Core Commands

# Project initialization
vdk init                         # Initialize with auto-detection
vdk init --interactive          # Interactive setup with guided choices

# Analysis and status
vdk scan                         # Re-analyze project and update rules
vdk status                       # Check current VDK configuration
vdk validate                     # Validate generated rules

# Utilities
vdk --help                       # Show all available commands
vdk --version                    # Display VDK CLI version

Configuration

VDK CLI automatically generates configuration files for your detected AI assistants:

{
  "project": {
    "name": "my-nextjs-app",
    "type": "web-application",
    "frameworks": ["nextjs", "react", "typescript"],
    "libraries": ["tailwindcss", "shadcn-ui"]
  },
  "integrations": {
    "claude-code": {
      "enabled": true,
      "memoryFiles": ["CLAUDE.md", "CLAUDE-patterns.md"]
    },
    "cursor": {
      "enabled": true,
      "rulesDirectory": ".ai/rules/"
    }
  }
}

Examples

Basic Project Setup

# Navigate to your project
cd my-nextjs-app

# Initialize VDK
vdk init

# VDK detects: Next.js, React, TypeScript, Tailwind CSS
# Generates: .ai/rules/ with 15+ tailored rules
# Configures: Claude Code memory files

Interactive Setup

# Interactive mode for custom configuration
vdk init --interactive

# Choose your AI assistants:
# ✓ Claude Code
# ✓ Cursor
# ✗ Windsurf
# ✗ GitHub Copilot

# Generates optimized rules for selected platforms

Advanced Usage

# Re-analyze after adding new dependencies
npm install prisma
vdk scan

# Check what VDK detected
vdk status

# Validate all generated rules
vdk validate

Real Impact

Teams using VDK CLI v2.0 report:

• 60% faster initial AI suggestions with enhanced technology detection
• 85% more relevant code completions with framework-specific rules
• 40% fewer back-and-forth clarifications through precise context
• 90% consistency in code patterns across team members
• 100% accuracy in package manager and build tool detection

Documentation

• Getting Started Guide - Complete setup instructions
• CLI Reference - All commands and options
• Rule Authoring Guide - Create custom rules
• Troubleshooting Guide - Common issues and solutions
• Scanner Documentation - Technical scanner details

Contributing

We welcome contributions! Please see our Contributing Guide for details.

• Report bugs
• Request features
• Improve documentation
• Submit pull requests

Roadmap

• [x] v2.0 - Enhanced technology detection, improved AI integrations
• [ ] v2.1 - VDK Hub integration for cloud-based rule management
• [ ] v2.2 - Visual Studio Code extension for seamless IDE integration
• [ ] v3.0 - Team collaboration features and shared rule repositories

Requirements

• Node.js: >= 22.0.0
• npm: >= 8.0.0 or pnpm >= 7.0.0
• Operating System: Windows, macOS, Linux

License

MIT License - see the LICENSE file for details.

Project Evolution & Attribution

VDK CLI is the evolution of a rich history of AI-assisted development tooling:

• Original DevRules by Seth Rose - Established the foundational concept of structured AI assistant rules
• AIRules - Major enhancement adding 51+ specialized tasks, memory management, and multi-platform support
• VibeKit VDK - The current evolution, a comprehensive toolkit for making AI assistants project-aware

For detailed history and contributions, see Project History & Attribution.

Support

• GitHub: Issues & Feature Requests
• Documentation: Complete Docs
• Community: VDK Hub
• Email: For enterprise support inquiries

Made with ❤️ by the VibeKit VDK community

GitHub • Documentation • VDK Hub • NPM