VK
GitHub

Commands Reference

Complete reference for all Vibe Kit CLI commands. You can use the short alias vk instead of vibe-kit.

Install & Setup

vibe-kit install

Install Vibe Kit in your current project. Creates .vibe-kit/ directory and configures integrations.

vibe-kit install

💡 Platform-Specific Installation

If .vibe-kit already exists (e.g., installed by another team member), add your specific AI tool integration:

vibe-kit cursorvibe-kit vscodevibe-kit claudevibe-kit geminivibe-kit codexvibe-kit aidervibe-kit continue

These commands only add the integration files for your specific AI tool without affecting the existing .vibe-kit/ directory.

vibe-kit status

Check installation status and verify which context files are loaded for AI prompts.

vibe-kit status

Shows which .md files will be loaded when you run vk "prompt"

vibe-kit analyze

Analyze your project and generate customized standards based on your actual codebase. Monorepo-aware: Automatically detects and prompts for frontend/backend scope.

vibe-kit analyze

Options:

  • --scope frontend|backend|both - Analyze specific scope (non-interactive)
  • --package <path> - Analyze specific package (e.g., apps/admin)
  • --non-interactive - Skip prompts

What it does: AI scans your codebase and generates content for skeleton standards files. ⚠️ You must review and edit the generated content manually.

📦 Monorepo Support:

For monorepos, automatically detects packages and prompts to analyze frontend, backend, or both. Generates separate standards when analyzing both.

Validation & Compliance

vibe-kit check

Validate installation and check policy compliance based on .vibe-kit/policies/policy.yml.

vibe-kit check

Options:

  • --strict - Treat warnings as errors
  • --verbose - Show detailed information

Corrections Logging

vibe-kit note

Add entries to the corrections log for tracking AI performance issues and improvements.

vibe-kit note "AI didn't follow testing standards"

Options:

  • --category <category> - Category (AI Behavior, Preferences, etc.)
  • --priority <priority> - Priority (HIGH, MEDIUM, LOW)
  • --task <task> - Related task description

Example: vk note "Good behavior observed" --category "Preferences" --priority LOW

Workflow Orchestration

vibe-kit run <workflow>

Execute structured workflows defined in .vibe-kit/instructions/core/.

vibe-kit run create-component

Options:

  • --interactive - Pause between steps for review

Workflows use XML-like tags (<process_flow>, <step>) for structured execution.

Registry & Versioning

vibe-kit publish

Package and publish your Vibe Kit configuration to the local registry for sharing across teams.

vibe-kit publish --name @company/react-standards --version 1.0.0

Creates a versioned archive in ~/.vibe-kit-registry.

vibe-kit pull <package>

Pull a Vibe Kit configuration from the registry.

vibe-kit pull @company/react-standards@1.0.0

Options:

  • --force - Overwrite existing files
  • --backup - Backup existing files before overwriting

Use @latest to pull the latest version.

Observability

vibe-kit dashboard

Start a web-based observability dashboard to visualize standards freshness, corrections log analytics, and policy compliance.

vibe-kit dashboard

Options:

  • --port <port> - Custom port (default: 3001)
  • --no-server - Display metrics in CLI only

Dashboard shows: standards freshness, corrections log statistics, policy compliance, and product context status.

Updates & Maintenance

vibe-kit update

Update Vibe Kit to the latest version.

vibe-kit update

AI Commands

vibe-kit <prompt>

Chat with AI using Vibe Kit context. Just type your prompt directly!

vibe-kit "create a button component"

✨ Shortcut: You can skip the "ai" keyword and just use vk "your prompt"

💡 How it works:

  • Automatically loads .vibe-kit/context.md
  • Includes all standards files (code-style, testing, architecture, guidelines)
  • Sends full context to your AI tool (Aider, Claude, Gemini)

vibe-kit ai <prompt>

Same as above, but with explicit "ai" keyword.

vibe-kit ai "create a button component"

Set your preferred AI tool with export AI_TOOL=aider

AI Tool Commands

Cursor (Auto-loads)

All context files are automatically loaded. Reference specific commands in chat:

@.vibe-kit/commands/analyze.md

VS Code Copilot

Use @ mentions to include context files in your prompts:

@.vibe-kit Create a login button

✅ One mention includes all context files

Claude / Gemini CLI

Reference files directly in your prompts:

read .vibe-kit/standards/code-style.md

When using Vibe Kit in AI tools, reference these files in your prompts:

@.vibe-kit/commands/analyze.md

Analyze and customize standards for your project

@.vibe-kit/commands/create-component.md

Create a new component following your patterns

@.vibe-kit/commands/create-feature.md

Create a new feature with all necessary files

@.vibe-kit/commands/run-tests.md

Run the test suite with coverage

@.vibe-kit/commands/quality-check.md

Run linting, type checking, and quality checks

@.vibe-kit/commands/add-documentation.md

Add documentation to your code

Short Alias Available

Use vk instead of vibe-kit for faster typing. Example: vk install

Was this helpful?

Help us improve the documentation by sharing your feedback.