gitkuro

::: {align="center"}

✦ gitkuro

Professional, fast, and elegant commits. Minimalism inspired by the aura of UseKuro.

Documentation • Contributing • Discord :::

⚡ Quick Start

# Install gitkuro
go install github.com/usekuro/gitkuro/cmd/gitkuro@latest

# Create your first commit
gitkuro commit

🌟 Why gitkuro?

Gitkuro is born as the professional alternative to gitmoji:

• Less decorated, more sober
• Real GitFlow + Conventional Commits workflow
• Fast and elegant Charm (bubbletea) interface
• Perfect for enterprises, teams, and open-source projects

<table>
<tr>
<td>

🤯 Before (gitmoji, manual)

git commit -m "✨ feat: add login endpoint"

• Colorful, less serious in corporate contexts
• Easy to misinterpret

</td>
<td>

🖤 With gitkuro

gitkuro commit
# TUI → Select type, scope, message
# Output:
✦ feat(api): add login endpoint

• Minimalist, sober
• 100% compatible with Conventional Commits
• Automatic scope detection from branch name

</td>
</tr>
</table>

🎯 Features

• Professional commit types: ✦ feat • ⚡ fix • ⎇ hotfix • ↻ refactor • 📑 docs • 🎯 test • 🛠 chore • ⬆ upgrade • 🏷 release

• Conventional Commits ready for semantic-release

• Automatic scope detection from feature/*, fix/*, etc.

• Preview before confirming

• Quick mode with flags:

  gitkuro commit -t feat -s api -m "add login endpoint"
  

• Breaking changes and footers (Refs, Co-authors)

• Charm TUI with bubbletea, bubbles, and lipgloss

🚀 Installation

Option 1: Go Install (Recommended)

go install github.com/usekuro/gitkuro/cmd/gitkuro@latest

Option 2: Using install.sh

curl -sfL https://raw.githubusercontent.com/usekuro/gitkuro/main/install.sh | sh

Option 3: From Source

git clone https://github.com/usekuro/gitkuro.git
cd gitkuro
make build
./bin/gitkuro --help

💡 Usage

Interactive

gitkuro commit

1. Select commit type
2. Enter scope, message, and body
3. Preview → confirmation
4. Executes git commit -m "<message>"

Quick Mode

gitkuro commit -t fix -s auth -m "correct session bug" --breaking --co-author "Alice <alice@mail.com>"

🏗️ Project Structure

gitkuro/
├── cmd/gitkuro/          # CLI entrypoint
├── internal/core/        # core logic (format, git, config)
├── internal/tui/         # Charm models and views
├── internal/version/     # version control
├── docs/                 # extended documentation
├── tests/                # tests
├── Makefile              # common tasks
├── install.sh            # installation script
├── README.md             # this file
├── CONTRIBUTING.md       # contribution guide
├── CODE_OF_CONDUCT.md    # code of conduct
├── SECURITY.md           # security policy
├── ROADMAP.md            # future vision
├── CHANGELOG.md          # changelog
├── LICENSE               # MIT License
└── .github/              # issue and PR templates

🧪 Development

# Install dependencies
go mod download

# Run tests
make test

# Lint
make lint

# Build
make build

🤝 Contributing

We want gitkuro to be useful for everyone.

• Use Conventional Commits in your PRs
• Check out Issues with the good first issue label
• Read CONTRIBUTING.md for details

📊 Roadmap

• Basic CLI with TUI
• Quick mode with flags
• Global and per-repo config
• semantic-release integration
• Formatting plugins
• Multi-language support

📄 License

MIT License -- see LICENSE for more information.

::: {align="center"} gitkuro -- professional commits within everyone's reach.

Website • Discord

Made with 🖤 by the UseKuro community. :::