Usage

This document will guide you through the usage of Comit. It will cover basic and advanced usage of the tool, as well as some of the more complex features of the tool.

Usage

Generating a Commit Message

To generate a commit message, ensure your changes are staged, then run the following command:

comit

This command will run git diff --staged, send the diff to your selected AI agent (you can choose or change the agent in the dashboard), and generate several commit message suggestions for you formatted according to Conventional Commits.

A sample output might look like:

Use the arrow keys to navigate: ↓ ↑ → ←
? Select commit message:
  > Refresh
    feat: add pagination support to /users endpoint
    fix: resolve 500 error when POST /login is called without payload
    chore: refactor API route handlers for better modularity
    docs: update API reference with new pagination and auth examples

Live Chat with Your Selected Agent

Start a live conversation with your preferred AI assistant:

comit live

You'll be prompted to chat and can ask for code, advice, or assistance:

give a function that returns the sum of two numbers in python
 
def sum_two_numbers(a, b):
    return a + b
 
> now in rust
 
 
fn sum(a: i32, b: i32) -> i32 {
a + b
}

Generate a Branch Name

Automatically generate a branch name based on a description:

comit -b "Add a New Feature to the User Profile Page"
# output
# feature/add-new-feature-user-profile-page
# bugfix/save-button-not-working-settings-page