Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@jinjos/vibe-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
vibe-cli 🔥
One vibe to rule them all - Unify your AI coding assistants with shared standards
Stop managing separate rule files for every AI tool. vibe-cli creates a single source of truth for your coding standards that works seamlessly across Claude Code, Cursor, GitHub Copilot, and Gemini CLI.
⚡ The Problem
Managing AI coding assistants is chaos:
- 📄 Cursor needs
.cursor/rules/*.mdcfiles - 🤖 Claude Code needs
CLAUDE.mdfiles - 🐙 GitHub Copilot needs
.github/instructions/files - 💎 Gemini CLI needs
GEMINI.mdfiles - 🔄 Same rules, different formats - nightmare to maintain
✨ The Solution
vibe-cli unifies everything:
- 📝 Write rules once in the
vibe/directory - 🚀 Auto-generate platform-specific configurations
- 🎯 Smart enforcement based on file types and context
- 🔄 Easy updates - change once, apply everywhere
🚀 Installation & Quick Start
Option 1: CLI Usage (Traditional)
# Install the CLI globally
npm install -g @jinjos/vibe-cli
# Navigate to your project
cd your-awesome-project
# Analyze your project (optional but recommended)
vibe analyze
# Initialize the vibe system
vibe init
# Check status and performance
vibe statusOption 2: MCP Integration (AI-First) 🤖
For seamless AI integration with Claude, Cursor, or other MCP-compatible clients:
{
"mcpServers": {
"vibe": {
"command": "npx",
"args": ["-y", "@jinjos/vibe-mcp"],
"cwd": "/path/to/your/project"
}
}
}That's it! Your AI tools now have direct access to vibe functionality and share the same coding standards.
📊 Platform Support
| Platform | Context Window | Configuration File |
|---|---|---|
| 🤖 Claude Code | 200K tokens | CLAUDE.md |
| 🎯 Cursor | 200K tokens | .cursor/rules/vibe.mdc |
| 🐙 GitHub Copilot | 64K tokens | .github/instructions/vibe.instructions.md |
| 💎 Gemini CLI | 1M tokens | GEMINI.md |
🎨 Smart Rule Enforcement
Define how each rule applies using YAML frontmatter:
🔴 Always Apply (Critical standards)
---
alwaysApply: true
description: "Core coding standards"
---
# Never compromise on these rules
- Use meaningful variable names
- Write tests for all functions🟡 File-Specific (Targeted rules)
---
globs: "*.ts,*.tsx"
applyTo: "**/*.ts,**/*.tsx"
description: "TypeScript best practices"
---
# Only applies to TypeScript files
- Use strict mode
- Define proper return types🔵 Intelligent (Context-aware)
---
description: "Performance optimization patterns"
alwaysApply: false
---
# AI decides when to apply based on context
- Use memoization for expensive calculations
- Implement lazy loading for large datasets⚪ Manual Only (On-demand)
---
alwaysApply: false
description: "Advanced optimization - use only when requested"
---
# Only applied when explicitly requested
- Complex performance optimizations
- Advanced architectural patterns🔧 Commands
vibe init - Initial Setup
vibe init # Auto-detect and setup all platforms
vibe init --platforms cursor,claude # Setup specific platforms only
vibe init --full # Complete setup: migrate rules AND remove originalsvibe sync - Keep Rules Synchronized
vibe sync # Sync ALL rules from Cursor/Copilot directories
vibe sync --platforms cursor # Only sync from Cursor
vibe sync --full # Sync rules AND remove originals
vibe sync --dry-run # Preview what would be syncedPerfect for teams: When teammates add rules to .cursor/rules/ or .github/instructions/ directories, vibe sync refreshes your vibe/ directory with all current rules. Rules with the same name will be overwritten.
vibe status - Monitor System Health
vibe status # Quick overview
vibe status --verbose # Detailed analysis with performance metricsvibe fix - Maintain Configuration
vibe fix --dry-run # Preview fixes without applying
vibe fix # Automatically resolve configuration issuesvibe cleanup - Remove Original Files
vibe cleanup # Remove files migrated by init (with backups)
vibe cleanup --dry-run # Preview what would be removedNote: Only removes files that were migrated during vibe init. For ongoing maintenance, use vibe sync --full instead.
vibe analyze - Comprehensive Repository Analysis
vibe analyze # Full repository and AI configuration analysis
vibe analyze --json # Output as JSON for automated processing
vibe analyze --verbose # Include detailed breakdowns
vibe analyze --recommendations # Focus on what's missing or needs updatingNEW: Get deep insights into your project:
- 🔍 Tech Stack Detection - Automatically identifies your languages, frameworks, databases
- 🤖 AI Configuration Analysis - Analyzes all your AI tool setups and token usage
- 📊 Rule Coverage Assessment - Shows what's covered vs missing in your AI instructions
- 🎯 Gap Analysis - Identifies missing rules for your specific tech stack
- 🔧 MCP Server Recommendations - Suggests relevant MCP servers based on your actual stack
- 📈 AI Configuration Maturity Score - Honest assessment of your AI setup quality
📁 Project Structure After Init
your-project/
├── vibe/ # 🎯 Your unified rules
│ ├── coding-standards.md # Core standards (always applied)
│ ├── typescript-rules.md # Language-specific rules
│ └── testing-standards.md # Workflow standards
├── CLAUDE.md # → Points to vibe/
├── GEMINI.md # → Points to vibe/
├── .cursor/rules/vibe.mdc # → Points to vibe/
└── .github/instructions/vibe.instructions.md # → Points to vibe/🔄 Automatic Migration
vibe-cli automatically discovers and migrates existing rules:
✅ Cursor - .cursorrules and .cursor/rules/*.mdc
✅ Claude Code - CLAUDE.md files
✅ Gemini CLI - GEMINI.md files
✅ GitHub Copilot - .github/copilot-instructions.md and .github/instructions/*.instructions.md
🔄 Common Workflows
Initial Project Setup
# Conservative approach (test first)
vibe init # Setup system, keep original files
vibe status # Verify everything works
vibe cleanup # Remove originals when confident
# Power user approach
vibe init --full # Complete setup in one commandOngoing Team Collaboration
# Teammate added rules to .cursor/rules/ or .github/instructions/
vibe sync # Refresh vibe/ with all platform rules
vibe sync --full # Sync and remove originals
# Monthly maintenance
vibe status --verbose # Check performance and health
vibe fix # Resolve any configuration issuesPlatform-Specific Management
# Only work with specific platforms
vibe init --platforms cursor,claude
vibe sync --platforms copilot # Sync only from Copilot
# Preview changes safely
vibe sync --dry-run # See what would be synced
vibe cleanup --dry-run # See what would be removedRepository Analysis & Optimization
# Understand your project's AI configuration maturity
vibe analyze # Get comprehensive analysis report
vibe analyze --recommendations # Focus on actionable improvements
# Use insights to improve your setup
vibe init # Setup vibe system based on analysis
# Create rules for detected gaps (MongoDB, Redis, etc.)
# Install recommended MCP servers for your tech stack📊 Performance Monitoring
Get platform-specific performance insights:
vibe status --verbose📊 Platform Performance Analysis:
✅ CURSOR (200,000 context limit):
📊 Current rules: 1,580 tokens (1% of context)
✅ LOW IMPACT - Performance should be good
⚠️ GITHUB COPILOT (64,000 context limit):
📊 Current rules: 1,580 tokens (2% of context)
💛 MODERATE IMPACT - Monitor performance
✅ GEMINI CLI (1,000,000 context limit):
📊 Current rules: 1,580 tokens (0% of context)
✅ LOW IMPACT - Performance should be good🤝 Why Developers Love vibe-cli
- 🎯 Single Source of Truth - Update rules once, apply everywhere
- 🔍 Intelligent Analysis - Deep repository analysis with actionable insights
- 🤖 Smart MCP Recommendations - Suggests relevant servers based on your actual tech stack
- 📊 Performance Aware - Monitors context usage and provides optimization guidance
- 🚀 Zero Configuration - Works out of the box with smart defaults
- 🔧 Self-Healing - Automatically fixes common configuration issues
- 🔄 Migration Friendly - Seamlessly imports existing rules
- 📈 Maturity Assessment - Honest scoring of your AI configuration quality
🆘 Troubleshooting
Rules not being applied?
vibe status --verbose # Check for configuration issues
vibe fix # Automatically resolve problemsPerformance issues?
vibe status # Check platform performance analysisWant to understand your project better?
vibe analyze # Get comprehensive analysis and recommendations
vibe analyze --verbose # Detailed breakdown with specific suggestionsNeed help?
- 📖 Documentation: GitHub Wiki
- 🐛 Bug Reports: GitHub Issues
- 💬 Discussions: GitHub Discussions
📄 License
MIT License - see LICENSE file for details
🔥 Give your AI tools the perfect vibe 🔥