🎨 gitmoji-cli

Interactive Gitmoji Commit CLI tool with Conventional Commits support.

✨ Features

• 🎨 58 built-in gitmojis with keyword search
• ⚡ Interactive CLI — pick emoji, type, scope, message step by step
• 📋 Conventional Commits support out of the box
• 🔍 Search gitmojis by keyword
• 📝 Breaking change flag support
• 🌐 Works anywhere — no external API needed

📦 Install

npm install -g @mazhu/gitmoji-cli

Or via npx:

npx @mazhu/gitmoji-cli <command>

🚀 Usage

Initialize (optional)

gitmoji init

Commit (interactive)

gitmoji commit

Flow:

1. Pick a gitmoji
2. Select commit type (feat, fix, docs, style, etc.)
3. Enter optional scope
4. Enter commit message
5. Add optional extended description
6. Mark as breaking change if needed
7. Confirm and commit

List all gitmojis

gitmoji list

Search gitmojis

gitmoji search bug      # search by keyword
gitmoji search feat     # find feature-related emojis
gitmoji search deploy   # find deployment emojis

Other commands

gitmoji version         # show version
gitmoji help            # show help

📋 Commit Message Format

🎨 feat(scope)!: add user authentication

Optional extended description here.

🎨 Available Gitmojis

| Emoji | Code | Description | |-------|------|-------------| | 🎨 | :art: | Improve structure / format of the code | | ⚡ | :zap: | Improve performance | | 🔥 | :fire: | Remove code or files | | 🐛 | :bug: | Fix a bug | | 🚑 | :ambulance: | Critical hotfix | | ✨ | :sparkles: | Introduce new features | | 📝 | :pencil: | Add or update documentation | | 🚀 | :rocket: | Deploy stuff | | 💄 | :lipstick: | Add or update the UI and style files | | 🎉 | :tada: | Begin a project | | ✅ | :white_check_mark: | Add, update, or pass tests | | 🔒 | :lock: | Fix security issues | | ♻️ | :recycle: | Refactor code | | 🔀 | :twisted_rightwards_arrows: | Merge branches | | 🧪 | :test_tube: | Adding a failing test | | ⬆️ | :arrow_up: | Upgrade dependencies | | ... | ... | 57 more |

🛠️ Develop

git clone https://github.com/deepdadou/gitmoji-cli.git
cd gitmoji-cli
npm install
npm link   # link globally
gitmoji help

📄 License

MIT © mazhu