VK
GitHub

Project Structure

After installation, Vibe Kit creates a comprehensive directory structure that provides context to AI assistants and organizes your development standards.

Directory Overview

When you run vibe-kit install, Vibe Kit creates a comprehensive directory structure:

Directory structure created:

your-project/
├── .vibe-kit/
│   ├── standards/
│   │   ├── glossary.md          ← Project shortcuts & terminology
│   │   ├── code-style.md        ← Coding conventions
│   │   ├── testing.md           ← Test patterns
│   │   ├── architecture.md      ← Architecture decisions
│   │   └── ai-guidelines.md     ← AI behavior rules
│   │   ├── README.md             ← Overview (real file)
│   │   └── workflows.md           ← Skeleton (run vk analyze)
│   └── context.md                ← Single context file for CLI
│
├── .cursor/rules/
│   └── vibe-kit.mdc             ← Makes AI read the .md files

ℹ️ Skeleton Files

Files marked "Skeleton" start as blank templates. Run vk analyze to generate content from your codebase.

The .vibe-kit Directory

This is the main directory where all your project standards and context files live:

standards/

Standards that AI reads as context

  • glossary.md- YOUR project shortcuts & terms
  • code-style.md- YOUR coding conventions
  • testing.md- YOUR test patterns
  • architecture.md- YOUR architecture decisions
  • ai-guidelines.md- AI behavior rules

Platform-Specific Integrations

Vibe Kit integrates with multiple AI platforms:

Cursor - .cursor/rules/vibe-kit.mdc

Automatic: Cursor reads all context files for every AI prompt via alwaysApply: true. No manual references needed!

Continue.dev - .continue/config.json

Auto-loads context files for Continue.dev integration across any editor.

Aider - .aider/rules.md

Automatically reads context files for Aider command-line AI assistance.

VS Code - .vscode/settings.json

Configuration settings for VS Code and GitHub Copilot integration. Note: Unlike Cursor, you must manually reference context files in your Copilot prompts (e.g., @.vibe-kit includes all files).

CLI Tools - .vibe-kit/scripts/ai-cli.sh

Universal helper scripts for Claude CLI, Gemini CLI, and other command-line AI tools.

Customization

All files in the .vibe-kit directory are meant to be customized for your project. After running vk analyze, modify them to match your team's specific needs:

  • Add project-specific terminology to glossary.md
  • Define your coding style preferences in code-style.md
  • Document your testing approach in testing.md
  • Capture architectural decisions in architecture.md
  • Set AI behavior expectations in ai-guidelines.md
  • Document workflows in workflows.md

Pro Tip

The more detailed and specific your context files are, the better AI assistants will understand your project and generate code that matches your exact patterns and preferences.

Was this helpful?

Help us improve the documentation by sharing your feedback.