Welcome to Vibe Kit

Context-aware AI development. Give your AI assistants structured context through markdown files and get code that matches your exact patterns and conventions.

No AI Hallucinations

AI has access to your actual standards, not generic patterns. It reads your real project structure and conventions.

Consistent Code

Every suggestion follows your specific patterns. TypeScript config, component structure, testing approach—all matched to your codebase.

Project-Specific Guidance

Tailored to your tech stack and team preferences. Update the markdown files as your project evolves.

Living Documentation

Your standards evolve with your project. Document decisions once, reuse them across all AI interactions.

Just want to try it out? Skip to the Quick Start.

The Context Engineering Flow

Vibe Kit works by providing structured context to AI assistants through markdown files. Here's how the flow works:

Example workflow:

Your Prompt: "Create a login button for customer app"

↓

AI Reads Context Files:

glossary.md → "customer" = apps/customer-app
glossary.md → "button" = Button component pattern
code-style.md → TypeScript strict mode
testing.md → Include numbered test cases

↓

Context-Aware Code Generated matching YOUR patterns

Auto-Detection & Integration

Vibe Kit automatically detects which AI tools you have installed and configures integrations accordingly:

$ vibe-kit install

🎵 Installing Vibe Kit...

✅ AI Tools detected: cursor, aider, claude_cli

✅ Cursor integration installed

✅ Aider integration installed

✅ CLI helpers installed

Use Cases

Context Engineering

Structure AI context through markdown files. Give AI assistants the right information to generate code that matches your patterns.

Development Toolkit

Complete toolkit for teams: type safety, quality checks, Git hooks, and standards. Maintain consistency across your codebase.

Team Collaboration

Shared standards, templates, and workflows ensure everyone follows the same patterns and best practices.

Context Files

These markdown files provide context to your AI assistant:

glossary.md

Project terminology and business terms (e.g., checkout, customer, order)

code-style.md

Your coding conventions and style preferences

testing.md

Testing patterns and expectations

architecture.md

Architecture decisions and patterns

ai-guidelines.md

AI behavior rules and best practices for AI interactions

Developer Experience

Vibe Kit is designed for a great Developer Experience when working with AI-assisted development:

Intuitive CLI

Clear commands with helpful output

TypeScript Support

Full type safety throughout

Automated Workflows

Saves time and reduces errors

Flexible Configuration

Match your team's needs

Get Started View on GitHub

Was this helpful?

Help us improve the documentation by sharing your feedback.