Configuration Guide

VDK CLI provides extensive configuration options to customize scanning behavior, rule generation, and IDE integrations. This guide covers all configuration methods and options.

Configuration Files

Primary Configuration: `vdk.config.json`

The main project-level configuration file:

{
  "version": "2.0.1",
  "project": {
    "name": "my-nextjs-app",
    "type": "web-application",
    "description": "Next.js application with TypeScript and Tailwind CSS"
  },
  "scanner": {
    "projectPath": ".",
    "outputPath": "./.ai/rules",
    "deepScan": false,
    "ignorePatterns": [
      "**/node_modules/**",
      "**/dist/**",
      "**/build/**",
      "**/.git/**",
      "**/.next/**"
    ],
    "useGitIgnore": true,
    "analysisLevel": "comprehensive"
  },
  "integrations": {
    "enabled": ["claude-code", "cursor"],
    "autoDetect": true,
    "claude-code": {
      "memoryFile": "CLAUDE.md",
      "enableCommands": true,
      "watchMode": false
    }
  },
  "hub": {
    "enabled": true,
    "endpoint": "https://vdk.tools",
    "autoSync": false
  },
  "rules": {
    "template": "default",
    "format": "markdown",
    "includeExamples": true,
    "detailLevel": "comprehensive"
  }
}

Configuration Methods

1. Configuration File

# Initialize with default config
vdk config init

# Edit configuration
vdk config edit

# Validate configuration
vdk config validate

2. Command Line Options

# Override scanner options
vdk init --deep --ignorePattern "**/tests/**" --projectPath ./src

# Override output path
vdk init --outputPath ./custom-rules

3. Environment Variables

# Debug mode
export VDK_DEBUG=true

# Custom hub endpoint
export VDK_HUB_URL=https://custom-hub.example.com

# Disable telemetry
export VDK_TELEMETRY=false

Next Steps

Scanner Configuration - Customize project analysis
Integration Setup - Configure IDE integrations
Hub Configuration - Connect to VDK Hub

Configuration

On this page