Navicommit

Navicommit is a CLI tool designed to help you write better commit messages.

Table of Contents

• 🌟 Features
• 📦 Installation
• 📖 Usage
• 🧩 Dependencies
• 📄 License
• ✍🏻 Author

🌟 Features

• Easy to use: Navicommit guides you through a series of questions to generate a commit message.
• Consistent: Navicommit helps you write consistent commit messages across your projects.

📦 Installation

We recommend to install Navicommit globally on your system. Use the following command:

npm install -g navicommit

To install Navicommit locally in your project, use the following command:

npm install navicommit --save-dev

📖 Usage

Usage with global installation

After installing Navicommit globally, you can use it with the following command:

navi commit

or with the alias:

navi c

Local use with npx

You can use Navicommit (without installing it) with npx:

npx navicommit c

Usage with local installation (requires a script)

Add a script to your package.json:

"scripts": {
  "commit": "navi commit",
}

Then you can run the script using npm:

npm run commit

---

Navicommit will guide you through a series of questions to generate an appropriate commit message.

Once the commit is generated, copy-paste it in your Terminal.

🧩 Dependencies

• commander
• inquirer

📄 License

This project is licensed under the MIT License.

✍🏻 Author

Louis-Antonin Lesieur