Skip to content

odutradev/commiter-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

89 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Commiter CLI

Commit Standardization Tool

NPM Downloads  Install Size  Version  License

Repository: https://github.com/odutradev/commiter-cli
Creator & Main Contributor: João Dutra (@odutradev)


🚀 Key Features

  • Automatic translation of commit messages
  • Standardized commit prefixes with emojis and keywords
  • Multiple pattern styles configurable via JSON
  • Auto-add files before committing (optional)

💾 Installation

npm install -g commiter-cli

Usage

commiter <command> [options]

Run commiter --help or commiter help to see all commands and flags.


⚡ Quick Start

  • List commands
    commiter help
  • Show version
    commiter version
  • Generate a commit
    commiter use

📦 Commands

config

Manage your CLI settings:

# Show all settings
commiter config list

# View current configuration
commiter config get

# Update a setting
commiter config update <key> <value>

# Reset to defaults
commiter config reset

use

Interactively create a standardized commit:

commiter use

help

Display usage information:

commiter help

version

Display the installed version:

commiter version

🤝 Contributing

Contributions, issues and feature requests are welcome!

  1. Fork the repo
  2. Create a branch (git checkout -b feature/XYZ)
  3. Commit your changes (git commit -m "feat: add XYZ")
  4. Push to the branch (git push origin feature/XYZ)
  5. Open a Pull Request

Please read CONTRIBUTING.md


📜 License

This project is licensed under the MIT License. See LICENSE for details.

About

A CLI tool to standardize and translate Git commit messages

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published