VDK Docs
Getting Started

Installation

Documentation for Installation

Installation Guide

This guide will help you install and set up VDK CLI on your system.

Prerequisites

  • Node.js: Version 22.0.0 or higher
  • npm or pnpm: For package management
  • Git: For version control (recommended)

Installation Methods

# Install globally (requires Node.js ≥22.0.0)
npm install -g @vibe-dev-kit/cli

# Verify installation
vdk --version

PNPM Installation

# Install globally with pnpm
pnpm add -g @vibe-dev-kit/cli

# Verify installation
vdk --version

Local Installation

If you prefer to install VDK CLI locally in your project:

# Install as a dev dependency
npm install --save-dev @vibe-dev-kit/cli

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

# Run via npx
npx vdk --version

# Or via pnpm
pnpm vdk --version

Verification

After installation, verify that VDK CLI is working correctly:

# Check version
vdk --version

# View help
vdk --help

# List available commands
vdk

Expected output:

VDK CLI v2.0.1: The world's first Vibe Development Kit - Make your AI assistant project-aware
Version: 2.0.1

Commands:
  init         Initialize VDK and generate project-aware blueprints
  update       Update blueprints from VDK-Blueprints repository
  status       Check VDK setup and integration status
  validate     Validate generated rules and configurations
  scan         Re-analyze project and update rules
  integrations Manage AI platform integrations

IDE Setup

VDK CLI works with various AI-powered IDEs. Install your preferred IDE:

Claude Code

npm install -g @anthropic-ai/claude-code

Cursor

Download from cursor.sh

Windsurf

Download from codeium.com/windsurf

GitHub Copilot

Available as VS Code extension or GitHub Copilot CLI

First Project Setup

Once installed, initialize VDK in your first project:

# Navigate to your project
cd your-project

# Initialize VDK (interactive mode)
vdk init --interactive

# Check integration status
vdk status --check-integrations

System Requirements

Minimum Requirements

  • RAM: 512MB available memory
  • Storage: 100MB free space
  • Network: Internet connection for VDK Hub features
  • RAM: 2GB+ for large projects
  • Storage: 1GB+ for comprehensive rule caching
  • Network: Stable connection for real-time updates

Configuration Files

After installation, VDK creates several configuration files:

your-project/
├── vdk.config.json          # Main VDK configuration
├── .claude/                 # Claude Code specific files
│   ├── CLAUDE.md           # Main project memory
│   ├── CLAUDE_COMMANDS.md  # Slash command definitions
│   ├── blueprints/         # Selected blueprints
│   └── memory/             # Memory chunks
├── .cursor/                 # Cursor AI specific files
│   └── rules/              # .mdc files with YAML frontmatter
├── .windsurf/              # Windsurf specific files
│   └── rules/              # XML memory files
└── .github/                # GitHub Copilot specific files
    └── copilot/            # JSON guidelines

Environment Variables

Optional environment variables for advanced configuration:

# GitHub token for blueprint repository access
export VDK_GITHUB_TOKEN=ghp_your_token_here

# Enable debug mode
export VDK_DEBUG=true

# Custom blueprint repository
export VDK_BLUEPRINTS_REPO=your-org/your-blueprints

# Disable telemetry
export VDK_TELEMETRY=false

# Blueprint cache directory
export VDK_CACHE_DIR=~/.vdk/cache

Troubleshooting Installation

Common Issues

Permission errors on global install:

# macOS/Linux: Use npm with --unsafe-perm
sudo npm install -g @vibe-dev-kit/cli --unsafe-perm

# Or configure npm to use a different directory
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH

Node.js version issues:

# Check Node.js version
node --version

# Update Node.js using nvm (recommended)
nvm install 22
nvm use 22

Module not found errors:

# Clear npm cache
npm cache clean --force

# Reinstall
npm uninstall -g @vibe-dev-kit/cli
npm install -g @vibe-dev-kit/cli

Verification Commands

# Check all dependencies
vdk status

# Test blueprint fetching
vdk update --verbose

# Verify AI platform integrations
vdk integrations --scan --confidence-threshold medium

# Validate configurations
vdk validate

Next Steps

After successful installation:

  1. Quick Start Tutorial - Get started with your first project
  2. Project Setup - Configure VDK for your specific needs
  3. CLI Reference - Explore all available commands

Getting Help

If you encounter issues during installation: