😍 Command line tool for enabling pretty emoji commits
Project description
lipsgit
💄 A command line tool for enabling pretty emoji commits
🤖 Automatically add emojis to your commits with semantic matching
⚙️ Fully customise emoji mappings to suit your team
🚀 Getting Started
🛠️ Installation
Use pip to install lipsgit:
pip install lipsgit
To optimally set up lipsgit, follow the Getting Started guide in the documentation.
🧑💻 Usage
The documentation for lipsgit is available at lipsgit.docs.joss.dev and contains a detailed guide on how to use lipsgit.
To list available commands, either run lipsgit with no parameters or execute lipsgit help:
The base command for the lipsgit CLI.
Subcommands
| Name | Description |
|---|---|
| add | Add a custom emoji entry to lipsgit |
| commit | Interactively commit with an emoji |
| hook | Run lipsgit as part of a commit_message hook |
| init | Initialize lipsgit configuration |
🤝 Contributing
We're excited that you want to contribute to lipsgit. Your help and contributions are greatly appreciated! Read the contribution guidelines to get started.
📜 Code of Conduct
We value your contribution and participation in our community. To ensure a positive and inclusive environment for all, we have established a Code of Conduct. Read the Code of Conduct to learn more.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
