Docs/Getting Started/Configuration

Configuration

Configure VGuard rules, presets, and adapters.

Config File

import { defineConfig } from '@solanticai/vguard';

export default defineConfig({
  presets: ['nextjs-15', 'tailwind', 'supabase'],
  agents: ['claude-code', 'cursor'],
  rules: {
    'security/branch-protection': {
      protectedBranches: ['main', 'master', 'staging'],
    },
    'quality/naming-conventions': false, // Disable a rule
    'quality/anti-patterns': { severity: 'warn' },
  },
  plugins: ['vguard-plugin-example'],
});

Resolution Order

  1. Rule defaults (lowest priority)
  2. Presets (applied in declaration order — last preset wins)
  3. User config (highest priority — always wins)

Supported Formats

FormatFilePriority
TypeScriptvguard.config.ts1 (highest)
JavaScriptvguard.config.js2
JSON.vguardrc.json3
package.json"vguard" field4 (lowest)

Options

presets

Array of preset IDs. See Presets.

agents

Array of AI agents: claude-code (runtime), cursor, codex, opencode (advisory).

rules

Per-rule config. false disables, true enables with defaults, object for custom options.

plugins

Array of npm package names exporting VGuardPlugin.