README
¶
pummit 🚛
Small Git commit CLI with emoji and AI-automation.
🚀 Features
- A series of methods of commits
- Alias management and TOML-based configuration
- Supporting MCP for agentic coding
- Cross-platform support for Windows, macOS, and Linux
🛠 Installation
go install github.com/HidemaruOwO/pummit@latest
Build from Source
git clone https://github.com/HidemaruOwO/pummit.git
cd pummit
go build -o pummit .
🎯 Usage
Commit
# Belief form
pummit sparkles "Add login page"
# Explicit command form
pummit commit --emoji sparkles "Add login page"
# Auto emoji from branchMapping
pummit commit --auto-emoji "Fix auth flow"
Config
pummit config validate
pummit config list
pummit config get base.emoji
pummit config set base.emoji false
pummit config reset --force
Alias
pummit alias add featx sparkles --emoji "✨"
pummit alias list
pummit alias delete featx --force
pummit alias reset --force
Doctor / Migrate / MCP
pummit doctor
pummit migrate
pummit migrate status
pummit migrate rollback --confirm
pummit mcp
📦 Built-in Aliases
| Alias | Emoji | Meaning |
|---|---|---|
s, feat, feature |
✨ | feature |
b, fix, error |
🐛 | bug fix |
d, doc, docs |
📚 | docs |
a, ui, design |
🎨 | ui |
c, wip |
🚧 | work in progress |
r, pr, merge |
♻️ | refactor |
l, test |
🚨 | test |
w, tool, config |
🔧 | config/tooling |
h, perf, performance |
🚀 | performance |
🧩 Config
Current config format is TOML.
Default location:
- Windows:
%AppData%/pummit/config.toml - macOS/Linux: config dir under
~/.config/pummit
Legacy config.json is migrated to TOML by pummit migrate and on compatible legacy paths.
📜 License
This project is licensed under the Apache License 2.0.
🤝 Reference
This repository was created using the MicroRepository template.
Made with ❤️ by HidemaruOwO
If the projects helps improve your quality of life, please ⭐ this repository!
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
app
Package app wires top-level application dependencies and startup flow.
|
Package app wires top-level application dependencies and startup flow. |
|
domain
Package domain contains side-effect-free core models and rules.
|
Package domain contains side-effect-free core models and rules. |
|
domain/alias
Package alias defines alias-related domain models and rules.
|
Package alias defines alias-related domain models and rules. |
|
domain/commit
Package commit defines commit message domain types and formatting rules.
|
Package commit defines commit message domain types and formatting rules. |
|
domain/config
Package config defines configuration domain models and validation rules.
|
Package config defines configuration domain models and validation rules. |
|
domain/emoji
Package emoji defines emoji-related domain models and resolution contracts.
|
Package emoji defines emoji-related domain models and resolution contracts. |
|
infra
Package infra contains adapters for git, config storage, external APIs, and MCP.
|
Package infra contains adapters for git, config storage, external APIs, and MCP. |
|
infra/config
Package config implements configuration storage, codecs, and migration.
|
Package config implements configuration storage, codecs, and migration. |
|
infra/emoji
Package emoji implements emoji catalog and Gitmoji API adapters.
|
Package emoji implements emoji catalog and Gitmoji API adapters. |
|
infra/git
Package git implements infrastructure adapters over the git CLI.
|
Package git implements infrastructure adapters over the git CLI. |
|
infra/mcp
Package mcp implements MCP server wiring and tool adapters.
|
Package mcp implements MCP server wiring and tool adapters. |
|
testutil
Package testutil contains helpers shared by unit, integration, and acceptance tests.
|
Package testutil contains helpers shared by unit, integration, and acceptance tests. |
|
testutil/configfile
Package configfile contains test helpers for temporary config files and fixtures.
|
Package configfile contains test helpers for temporary config files and fixtures. |
|
testutil/gitrepo
Package gitrepo contains test helpers for temporary git repositories.
|
Package gitrepo contains test helpers for temporary git repositories. |
|
ui
Package ui contains interactive terminal-facing components.
|
Package ui contains interactive terminal-facing components. |
|
ui/prompt
Package prompt contains confirmation and editor prompt UI components.
|
Package prompt contains confirmation and editor prompt UI components. |
|
usecase
Package usecase contains application services that orchestrate domain and infrastructure.
|
Package usecase contains application services that orchestrate domain and infrastructure. |
|
legacy
|
|
Click to show internal directories.
Click to hide internal directories.