Vuku

An interactive CLI tool to help create git branches and conventional commit messages with emojis. This tool makes it easy to follow the Conventional Commits specification while adding some fun with emojis! 🎉

Features

• 🌳 Smart branch management
  • Warns when on main/master branch
  • Enforces branch naming conventions
  • Supports common branch types (feature/, bugfix/, etc.)
• 📝 Interactive prompts for creating commit messages
• 🎯 Follows Conventional Commits specification
• 😊 Optional emoji support
• 🔍 Scope support
• 💥 Breaking changes support
• 📚 Body and footer support
• 🎨 Colorful terminal output

Usage

Simply run the command in any git repository:

npx vuku

Options

• -s, --skip-emoji: Skip adding emojis to commit messages
• -d, --detailed: Show additional optional fields (scope, breaking changes, body, footer)
• -V, --version: Output the version number
• -h, --help: Display help information

Basic vs Detailed Mode

By default, vuku runs in basic mode, asking only for essential commit information:

• Type of change
• Description
• Breaking changes indicator

When run with --detailed flag, additional fields become available:

• Scope (optional)
• Extended description (optional)
• Footer notes (optional)

Installation (Optional)

While npx is the recommended way to use vuku, you can install it globally if you prefer:

npm install -g vuku

Then run it with:

vuku

Installing from source

git clone https://github.com/yourusername/vuku.git
cd vuku
npm install
npm run build
npm install -g .

Branch Types

The tool supports the following branch types:

• feature/ - For new features
• bugfix/ - For bug fixes
• hotfix/ - For urgent fixes
• release/ - For release branches
• support/ - For support branches

Commit Types

The tool supports the following commit types:

• ✨ feat: A new feature
• 🐛 fix: A bug fix
• 📚 docs: Documentation only changes
• 💎 style: Changes that do not affect the meaning of the code
• ♻️ refactor: A code change that neither fixes a bug nor adds a feature
• ⚡️ perf: A code change that improves performance
• 🧪 test: Adding missing tests or correcting existing tests
• 🏗️ build: Changes that affect the build system or external dependencies
• 👷 ci: Changes to CI configuration files and scripts
• 🔧 chore: Other changes that don't modify src or test files
• ⏪ revert: Reverts a previous commit

Example Output

Basic mode:

? Select the type of change you're committing: ✨ feat: A new feature
? Enter a short description: add user authentication
? Are there any breaking changes? No
✅ Successfully created commit!

Detailed mode (`