VDK CLI Documentation

The World's First Vibe Development Kit

VDK CLI is an advanced command-line toolkit that analyzes your codebase and generates project-aware AI assistant configurations using curated blueprints. It bridges the gap between your project's specific context and AI assistants like Claude Code, Cursor, Windsurf, and GitHub Copilot by fetching relevant blueprints from the VDK-Blueprints repository and adapting them to your project's unique characteristics.

What is VDK?

VDK (Vibe Development Kit) v2.0.1 automatically scans your project to understand its:

• Architecture patterns (MVC, MVVM, Microservices, Feature-sliced design)
• Technology stack (React 19, Next.js 15, Vue 3, Python, TypeScript, etc.)
• Framework conventions (Next.js App Router, Supabase, Tailwind CSS 4)
• Project structure and dependencies
• Naming conventions and coding patterns
• Build tools (Vite, Webpack, etc.)

It then fetches relevant blueprints from the VDK-Blueprints repository (109 expert-curated blueprints) and generates intelligent, project-specific configurations that make your AI assistant understand your project's context, conventions, and requirements.

Quick Start

# Install VDK CLI (requires Node.js ≥22.0.0)
npm install -g @vibe-dev-kit/cli
# or
pnpm add -g @vibe-dev-kit/cli

# Initialize VDK in your project
vdk init

# Interactive mode with guided setup
vdk init --interactive

# Check current VDK configuration
vdk status

# Update blueprints and configurations
vdk update

CLI Demo

Interactive setup mode guides you through project analysis and configuration

Quick initialization mode for rapid setup

Screenshots

Interface Gallery

Modern CLI interface with glass morphism design showcasing project analysis

Technology detection and blueprint selection interface

Configuration generation and deployment process

Status overview and integration confirmation

VDK Hub web interface for managing and sharing blueprints

Key Features

🔍 Intelligent Project Analysis

• ProjectScanner: Deep codebase traversal with .gitignore respect
• TechnologyAnalyzer: Detects 20+ technologies, frameworks, and build tools
• PatternDetector: Advanced naming convention and architectural pattern recognition
• Dependency Analysis: Comprehensive project structure mapping

🎯 AI Assistant Integration

• Universal Compatibility: Claude Code, Cursor, Windsurf, GitHub Copilot
• Platform Adapters: Specialized adapters for each AI platform
• Multi-IDE Support: Simultaneous configuration of multiple platforms
• Confidence Scoring: Integration reliability assessment (low/medium/high)
• File Format Adaptation: Platform-specific outputs (.claude/, .cursor/, .windsurf/, .github/copilot/)

🚀 Remote Blueprint System

• Blueprint Repository: Fetches from GitHub (entro314-labs/VDK-Blueprints)
• Dynamic Discovery: Runtime discovery of available categories and commands
• Light Templating: ${variable} substitution for project-specific customization
• Version Management: Blueprint currency tracking and update notifications
• Relevance Scoring: Sophisticated algorithms match blueprints to project characteristics

⚙️ Extensible Architecture

• RuleGenerator: Synthesizes analysis results using remote blueprints
• IntegrationManager: Handles multi-platform deployment
• Fallback Generation: Local rule creation when remote fetch fails
• Watch Mode: Continuous monitoring for project changes
• Schema Validation: VDK ecosystem standards (v2.1.0) compliance

Documentation Sections

Getting Started

• Installation Guide
• Quick Start Tutorial
• Project Setup

CLI Reference

• Command Overview
• Configuration Options
• Examples

Integrations

• Supported IDEs
• Claude Code Integration
• Cursor Integration
• Windsurf Integration
• GitHub Copilot Integration

Scanner System

• How Scanning Works
• Pattern Detection
• Technology Analysis
• Configuration

Templates & Rules

• Rule Format Specification
• Creating Custom Templates
• Template Library

VDK Hub

• Hub Overview
• Deploying Rules
• Team Collaboration

Advanced Usage

• Watch Mode
• Custom Integrations
• API Reference

Troubleshooting

• Common Issues
• Debug Mode
• FAQ

Community & Support

• GitHub: entro314-labs/VDK-CLI
• Issues: Report bugs and feature requests
• License: MIT
• Version: 2.0.1
• Requirements: Node.js ≥22.0.0

Architecture Overview

┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│   VDK CLI       │    │   Blueprint      │    │   AI Assistant  │
│   v2.0.1        │    │   Repository     │    │   Platforms     │
│                 │    │                  │    │                 │
│  ┌─────────────┐│    │  109 Blueprints│    │  Platform       │
│  │ Commands    ││────│  7 Categories    │────│  Adapters       │
│  │ • init      ││    │  Schema v2.1.0   │    │  • Claude Code  │
│  │ • status    ││    │                  │    │  • Cursor       │
│  │ • update    ││    │  Remote Fetching │    │  • Windsurf     │
│  └─────────────┘│    │  Light Templating│    │  • Copilot      │
└─────────────────┘    └──────────────────┘    └─────────────────┘
         │                       │                       │
         └───────────────────────┼───────────────────────┘
                                 │
                    ┌──────────────────┐
                    │   VDK Hub        │
                    │   vdk.tools      │
                    │                  │
                    │  Web Platform    │
                    │  Collections     │
                    │  Team Sharing    │
                    └──────────────────┘

VDK CLI creates a seamless workflow where your project's intelligence, combined with expert-curated blueprints, enhances your AI assistant's understanding, leading to 60% faster and more accurate, context-aware, and productive coding sessions.