coco

Spawned by the dream to automate away the tedium of writing commit messages, coco has grown into a multi-facetted git assistant to expedite any developer git workflow.

Currently coco generates commit messages, creates changelogs, summarizes code changes, perform code review, and more - with new features being added regularly!

Commands

• commit: generates commit messages based on staged changes.

• changelog: create changelogs for the current branch or a range of commits.

• recap: summarize changes from working-tree, or yesterday, or in the last month, or since the last tag.

• review: perform a code review on the changes in the working directory.

• init: step by step wizard to set up coco globally or for a project.

• help: display help for coco commands.

Getting Started

coco init is the first step to getting started with coco. It will guide you through the installation process, including setting up your OpenAI API key and configuring coco to your preferences.

1# For local project use
2npx git-coco@latest init -l project
3
4# For global use
5npx git-coco@latest init -l global

Usage

coco commit

Generates commit messages based on staged changes.

1coco
2
3# or 
4
5coco commit

Useful options

1# --append
2# Add content to the end of the generated commit
3coco --append "Resolves #128"
4
5# --append-ticket
6# Automatically append Jira/Linear ticket ID from the branch name to the commit message 
7coco --append-ticket
8
9# --additional
10# Add extra context before generating the commit
11coco --additional "Resolves UX bug with sign up button"

coco changelog

Creates changelogs.

1# For the current branch
2coco changelog
3
4# For a specific range (using HEAD references)
5coco changelog -r HEAD~5:HEAD
6
7# For a specific range (using commit hashes)
8coco changelog -r abc1234:def5678
9
10# For a target branch
11coco changelog -b other-branch
12
13# For all commits since the last tag
14coco changelog -t

coco recap

Summarize the working-tree, or other configured ranges

1# Summarize all working directory changes
2coco recap
3
4# Or these available ranges
5coco recap --yesterday | --last-week | --last-month | --last-tag

Stdout vs. Interactive Mode

coco offers two modes of operation: stdout and interactive, defaulting to stdout. You can specify your preferred mode in your config file or via command line flags.

1# Stdout mode
2git commit -m $(coco)
3
4# Interactive mode
5coco -i

Generate and commit all in one

coco can generate and commit your changes in one command.

1coco -s

Configuration

The .coco.config documentation has moved to our wiki. Here, you'll find detailed information on setting up and customizing your experience.

Ignoring Files

You can specify files to be ignored when generating commit messages by adding them to your config file or via command line flags. Read more about ignoring files & extensions in the wiki.

Contribution

We welcome contributions! Check out our CONTRIBUTING.md for more information.

Project Stats

License

MIT © gfargo