Quick Start
Get started with Vibe Kit in 3 simple steps. This guide walks you through installation, setup, and your first use.
📋 Prerequisites
- Required: Node.js 14.x or higher (16.x+ recommended), npm or yarn
- Optional: Git (needed for Git hooks feature)
- Optional: AI tools (Cursor, VS Code, Aider, etc.) - auto-detected during install
1Install Vibe Kit
Install globally to use it across all your projects:
npm install -g @nolrm/vibe-kitOr use without installing: npx @nolrm/vibe-kit@latest install
2Install in Your Project
Navigate to your project directory and run install:
cd your-projectvibe-kit installThis creates the .vibe-kit/ directory with skeleton standards files (blank templates). Vibe Kit auto-detects your project type and AI tools. After install, run vk analyze to generate content for these files.
💡 Multi-Team Workflow
If .vibe-kit already exists, add your specific AI tool:
vibe-kit cursorvibe-kit vscodevibe-kit claudevibe-kit geminivibe-kit aidervibe-kit continue3Customize for Your Project
Run analyze to customize standards to your tech stack:
vibe-kit analyze🎯 What analyze does:
- Scans your project structure and dependencies
- Detects existing patterns and configurations
- Generates standards content based on your actual codebase
- Creates project-specific AI guidelines
- ⚠️ Important: Review and edit the generated content manually
You're Ready to Go!
Vibe Kit is now configured. Here's what to do next:
Use in Cursor
Cursor automatically loads all context files. Try: Create checkout flow for customer
Use in VS Code
In Copilot Chat: @.vibe-kit Create checkout flow for customer
Customize Standards
Edit files in .vibe-kit/standards/ to match your team's preferences.
Check Status
Run vibe-kit status to see detected AI tools.
What Gets Created?
Vibe Kit creates a .vibe-kit/ directory with standards, templates, and commands. Auto-detects your AI tools (Cursor, VS Code, Aider, etc.) and configures integrations automatically.
Was this helpful?
Help us improve the documentation by sharing your feedback.