coco 🤖 🦍

Commit Copilot, or coco, is your personal scribe for git commit messages. Leveraging the power of LangChain🦜🔗 and LLMs to encapsulate your staged changes into meaningful commit messages!

Installation

Get started by adding coco to your project's development dependencies:

npm i git-coco --save-dev

Or, for global access, you can install coco system-wide:

npm i -g git-coco

Usage

There are two main ways to use coco:

1. Interactive Mode
2. Command Line Interface (CLI)

Interactive Mode

Just type coco and let the friendly prompts guide you through the commit process!

coco -i

The interactive mode offers you several benefits:

• Preview and approve or regenerate the commit message before it's committed
• Customize your prompts for a personalized commit experience

Command Line Interface (CLI)

If you're the type who likes to keep it simple, you can pass your commit message directly as a CLI argument:

coco --openAIApiKey="sk_your-openai-api-key"

Assuming you've stored your API key in the config file (learn more), you can also commit with:

git commit -m $(coco)

Alternatively, take advantage of coco's full potential by allowing it to make the commit for you!

coco -s

The coco.config

coco.config houses the project-level settings and can be defined in multiple places, adhering to a hierarchical order of priority. If the same configuration is found in multiple places, the higher priority one will be considered.

From highest to lowest, the priority order is:

1. Command Line Flags: Flags in the command line have the highest priority, and they override all other settings.
2. Environment Variables: Next in line are environment variables. You can set any configuration option as an environment variable.
3. Project Config (.coco.config.json): Create a .coco.config.json file in your project root to set configurations. It's recommended to store your OpenAI API key here alongside any other project-specific configurations.
4. Git Profile (.gitconfig): You can define coco settings under a [coco] section in your git profile. These settings will be used unless overridden by higher-priority ones.
5. XDG Configuration Directory: If XDG_CONFIG_HOME is set, coco will look for a coco/config file in this directory for configurations.

Here's an example .coco.config.json file:

{
    "openAIApiKey": "sk_your-openai-api-key",
}

And the same settings in .gitconfig:

[coco]
    openAIApiKey = sk_your-openai-api-key

Remember, command line flags and environment variables should be defined in UPPER_SNAKE_CASE. For instance, the openAIApiKey setting becomes OPENAI_API_KEY.

Options

Roadmap

• Interactive mode 🤖
• Stdout 📤
• LangChain integration 🦜
• Additional tests! 🧪
• Conventional commits 🔜
• HuggingFace integration 🔜
• Google Vertex AI integration (?)
• Automatic changelog generation 🫣
• Rebase support 🔀
• coco --amend b31dfc 👩‍💻

...and more! 🧑‍🔬 🚀

Contribution

Have an idea for a feature or want to get involved, we welcome contributions!

Please check out our CONTRIBUTING.md for more information.