vibe-codex

Automated development rules and workflow enforcement for modern software teams

Migration Notice: This repository has evolved from the original mandatory-rules-checker project. If you were using the legacy system, please see the migration guide. Legacy compatibility is maintained temporarily in the legacy/ and scripts/ directories.

🚀 Quick Start

npx vibe-codex init

📋 What is vibe-codex?

vibe-codex automatically enforces development best practices through:

• 🔒 Pre-commit security checks
• 🧪 Test coverage requirements
• 📝 Documentation standards
• 🔄 PR/Issue workflow automation
• 🚀 Deployment validations

💻 Installation

One-time use (recommended)

npx vibe-codex init

Global installation

npm install -g vibe-codex
vibe-codex init

As project dependency

npm install --save-dev vibe-codex

🎯 Basic Usage

Initialize in your project

cd your-project
npx vibe-codex init

# With options
npx vibe-codex init --type fullstack --minimal

# With advanced hooks
npx vibe-codex init --with-advanced-hooks "issue-tracking,pr-management"

Configure modules

npx vibe-codex config

Validate your project

npx vibe-codex validate

Update to latest rules

npx vibe-codex update

⚙️ Configuration

vibe-codex uses a .vibe-codex.json file for configuration:

{
  "modules": {
    "testing": {
      "framework": "jest",
      "coverage": { "threshold": 80 }
    },
    "github": {
      "features": ["pr-checks", "issue-tracking"]
    }
  }
}

See Configuration Guide for all options.

📦 Available Modules

• Core - Basic git workflow and security
• Testing - Test frameworks and coverage
• GitHub - PR/Issue automation
• Deployment - Platform-specific checks
• Documentation - README and docs standards

🔧 Advanced Hooks (Optional)

Additional development workflow automation:

• Issue Tracking - Automatic issue updates and progress tracking
• PR Management - PR health checks and review enforcement
• Quality Gates - Test coverage and security validations
• Context Management - Keep project documentation up to date

Install during init or with: npx vibe-codex init --with-advanced-hooks "issue-tracking,quality-gates"

See Modules Guide for details.

📚 Documentation

• Getting Started - Installation and setup guide
• Configuration - Configuration options
• CLI Reference - Command line usage
• API Reference - Programmatic usage
• Modules - Available modules
• Migration Guide - Upgrading from v1.x
• Troubleshooting - Common issues

🤝 Contributing

See CONTRIBUTING.md

📄 License

MIT © vibe-codex contributors