@arietta-studio/arietta-compass

Arietta Compass

Arietta Compass is a CLI tool that uses ChatGPT to generate Gitmoji-based commit messages

Changelog · Report Bug · Request Feature

Table of contents

TOC

• ✨ Features
• 📦 Installation
• 🤯 Usage
  • Git hook
  • Configuration
  • Options
• ⌨️ Local Development
• 🤝 Contributing
• 🔗 Links
  • More Products
  • Credits

✨ Features

• [x] 🤯 Supports auto-generating commit messages based on diffs using ChatGPT
• [x] 🛠️ Supports streamlined commit message editing workflow
• [x] 😜 Supports adding Gitmojis
• [x] 📝 Supports Conventional Commits specification
• [x] ⚡️ Supports pulling a list of issues and convenient binding
• [x] 💄 Supports custom prompts
• [x] 🗺️ Supports multi-language commit messages

📦 Installation

To install Arietta Compass, run the following command:

npm install -g @arietta-studio/arietta-compass

[!IMPORTANT]
Please make sure you have Node.js version >= 18

🤯 Usage

You can use the arietta-compass command to generate a commit message for your staged changes:

$ git add <files...>
$ arietta-compass

[!NOTE]
Use the acgit alias if arietta-compass is too long for you.

AI mode

With AI mode, you can generate a complete commit message using ChatGPT.

[!IMPORTANT]
To use AI auto-generation, you need to fill in your OpenAI token in the settings by arietta-compass -o. and if you have special network requirements, you can add OpenAI's forwarding address in the settings.

Editor mode

In Editor mode, you can choose the <type>(<optional scope>): <subject> [<issues>] format by following a simple flow.

[!NOTE]
If your project is a GitHub repository, the Editor mode feature will automatically fetch the issues associated with your repository. You can select multiple issues to link to your commit message by space .

Git hook

You can integrate Arietta Compass with Git via the prepare-commit-msg hook. This allows you to use Git as you normally would and edit the commit message before committing.

Install

To install the hook in the Git repository, run the following command:

$ arietta-compass --init # or use short flag -i

Uninstall

To uninstall the hook from the Git repository, run the following command:

$ arietta-compass --remove # or use short flag -r

Configuration

To configure Arietta Compass, run the following command:

$ arietta-compass --option # or use short flag -o

• To use AI auto-generation, you need to fill in your OpenAI token in the settings.
• To automatically pull private issues, you need to fill in your GitHub token with repo permissions in the settings.

Options

Arietta Compass supports the following options:

--commit -c Interactively commit using the prompts
--option -o Setup arietta-compass preferences
--help -h Print basic options
--init -i Initialize arietta-compass as a commit hook
--remove -r Remove a previously initialized commit hook
--list -l List all the available commit type
--version -v Print arietta-compass installed version

⌨️ Local Development

You can use Github Codespaces for online development:

Or clone it for local development:

$ git clone https://github.com/arietta-studio/arietta-tools.git
$ cd arietta-tools
$ bun install
$ cd packages/arietta-compass
$ bun dev

🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub Issues to get stuck in to show us what you’re made of.

Credits

• langchainjs - https://github.com/hwchase17/langchainjs
• ink - https://github.com/vadimdemedes/ink
• gitmoji-commit-workflow - https://github.com/arvinxx/gitmoji-commit-workflow
• gitmoji-cli - https://github.com/carloscuesta/gitmoji-cli

---

📝 License

Copyright © 2024 Arietta Studio.
This project is MIT licensed.