Configuration

Plugin Options

import knipUi from 'vite-plugin-knip-ui'

export default defineConfig({
  plugins: [
    knipUi({
      base: '/__knip-ui', // Custom base path (default: /__knip-ui)
    }),
  ],
})

See Plugin Options Reference for all available options.

Knip Configuration

This plugin uses your project's Knip configuration. If no config is found, a warning banner will appear in the UI.

Quick Setup

npx knip --init

This creates a knip.json with sensible defaults for your project.

Manual Setup

Create knip.json in your project root:

{
  "$schema": "https://unpkg.com/knip@latest/schema.json",
  "entry": ["src/main.ts"],
  "project": ["src/**/*.ts"]
}

See Knip Configuration Reference for detailed options.

Framework Integration

Knip automatically detects and configures plugins for popular frameworks:

• Vue / Nuxt
• React / Next.js
• Svelte / SvelteKit
• Astro
• And many more

No additional configuration is typically needed for standard setups.