@lapstimef1/aicommit

AiCommit

Generate detailed commit messages for your projects using AI 🤯
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

(back to top)

Getting Started

Installation

1. Install the package:

   • npm

   npm install @lapstimef1/aicommit -g

   • yarn

   yarn add @lapstimef1/aicommit -g

   • pnpm

   pnpm i -g @lapstimef1/aicommit

2. Init your configuration:

       aicommit config -g emoji

   This will create your config file.

3. Set the keys of the config:

       aicommit config -s <key>=<value>

Available keys:

Keys	Type of value	Details
emoji	boolean	Specify if the msg need to start with an emoji
scope	boolean	Specify if the msg need a scope : emoji type**(scope)**: description
autoPush	boolean	Specify if the msg need to push automatically after the commit
description	boolean	Specify if the msg need to have a description

(back to top)

Usage

Install the package like the previous step says, then in your git project, add a file git add (file name), then do aicommit.

(back to top)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-v3.0 License. See LICENSE for more information.

(back to top)

Contact

Your Name - @lapstime_ - [e-mail]

Project Link: https://github.com/LapsTimeOFF/aicommit

(back to top)