VDK Documentation

The World's First Vibe Development Kit

VDK is a comprehensive ecosystem that transforms AI coding assistants into project-aware experts. The system is organized into five ordered components:

What is VDK?

• 📐 ai-context-schema: Canonical contract for blueprint structure, kinds, and compatibility metadata
• 📚 VDK Blueprints: Curated canonical blueprint library (generic-to-specific, low-noise)
• 🖥️ VDK CLI: Execution core that retrieves, adapts, and deploys blueprints into user projects
• 🌐 VDK Hub: Discovery/distribution platform synchronized with canonical blueprint content
• 📘 VDK Wiki: Documentation surface describing schema and CLI-aligned operational behavior

CLI-first rule: runtime retrieval and deployment semantics are defined by VDK CLI and mirrored by Hub/Wiki.

Quick Start

Option 1: Use VDK CLI (Automated)

# Install and analyze your project (requires Node.js ≥22.0.0)
npm install -g @vibe-dev-kit/cli
vdk init --interactive
vdk status --check-integrations

Option 2: Use VDK Hub (Manual)

# Browse and download blueprints
Visit: https://vdk.tools
Select your tech stack → Download → Import to AI assistant

Documentation Sections

🚀 Getting Started

• Installation Guide
• Quick Start Tutorial
• What are Blueprints?

🏗️ Ecosystem Overview

• Three-Tier Architecture
• Component Integration
• Performance & Security

🖥️ VDK CLI

• CLI Overview
• Commands Reference
• Project Setup
• Scanner System
• Watch Mode

🌐 VDK Hub

• Hub Overview
• Using the Platform
• Blueprint Generator
• Collections

📚 VDK Blueprints

• Blueprints Overview
• Core Concepts
• Blueprints Reference
• Development Guide

🔗 Integrations

• Supported Platforms
• Claude Code
• Cursor
• Windsurf
• GitHub Copilot

⚙️ Configuration

• Configuration Files
• Rule Formats
• Templates
• Memory Management

🆘 Support

• Troubleshooting
• Common Issues
• FAQ
• Community

Community & Support

• GitHub: VDK Ecosystem
• Documentation: Browse this comprehensive guide
• Issues: Report bugs and request features
• Discussions: Join the community conversation
• License: MIT

Next Steps

1. New to VDK? → Start with Getting Started
2. Want automation? → Try VDK CLI
3. Prefer manual control? → Explore VDK Hub
4. Building rules? → Check VDK Blueprints

VDK creates a seamless workflow where your project's intelligence enhances your AI assistant's understanding, leading to more accurate, context-aware, and productive coding sessions.