English | 中文 | 日本語 | Français | Español | العربية | 한국어 | Português | Русский | Deutsch

🔖 git-format | Git 格式化 | Gitフォーマット | Format Git | Formato Git | تنسيق Git

npx @liangzhengtao/git-format — Conventional commits, zero effort.

Format git commit messages according to conventional commits. No API key needed.

---

📑 Table of Contents

• 🚀 Quick Start
• 🔍 What It Does
• 💡 Examples
• ⚙️ Options
• 📊 Type Detection
• 🔧 CI Integration
• 🔗 See Also
• 📄 License

---

🚀 Quick Start

# Stage your changes
git add .# Auto-format and commit
npx @liangzhengtao/git-format
# Or just preview (dry run)
npx @liangzhengtao/git-format --dry-run

🔍 What It Does

1. Reads your staged files
2. Detects the commit type (feat/fix/docs/test/etc.)
3. Detects the scope from file paths
4. Generates a conventional commit message
5. Commits with the formatted message

💡 Examples

# Stage a new feature
git add src/auth/login.ts
npx @liangzhengtao/git-format
# → feat(auth): add new feature in src/auth/login.ts# Stage a bug fix
git add src/api/users.ts
git commit -m "fix bug"
npx @liangzhengtao/git-format
# → fix(api): fix issue in src/api/users.ts# Stage documentation
git add README.md
npx @liangzhengtao/git-format
# → docs: update documentation

⚙️ Options

npx @liangzhengtao/git-format [options]
Options:
-d, --dry-run Show message without committing
-j, --json Output as JSON
-q, --quiet Suppress output
-h, --help Display help
-V, --version Display version

📊 Type Detection

Pattern	Type
*.test.ts, *.spec.ts	test
*.md, *.txt	docs
*.css, *.scss	style
package.json	chore
.github/*	ci
Dockerfile	build
Diff contains "fix", "bug"	fix
Diff contains "add", "new"	feat
Default	refactor

🔧 CI Integration

# GitHub Actions
- name: Auto-format commitsrun: | git add . npx @liangzhengtao/git-format git push

---

🔗 See Also

Project	Description
agent-trace	Visualize and debug AI agent execution traces
ai-commit	npx @liangzhengtao/commit-ai — AI writes your commit messages
vibe-check	npx @liangzhengtao/vibe-check — Is your project AI-ready?
awesome-ai-rules	20 production AI coding rules

---

📄 License

MIT

---

Found this useful? Give it a ⭐