autocommit

Leverage the power of LLMs to automatically generate commit messages based on the staged changes in your git repository.

• Usage
• Commands
• License

Usage

Install the CLI globally using npm:

npm install -g @floriandejonckheere/autocommit

Or run it directly using npx:

npx @floriandejonckheere/autocommit

Configure the CLI by running:

autocommit configure

This will create a ~/.autocommit.mjs file where you can set the default options for the CLI.

Ensure the environment variable GEMINI_API_KEY is set with your Gemini API key, which can be obtained from the Google Cloud Console.

Generate a commit message based on the staged changes in your git repository by running:

autocommit generate

See the Commands section below for more details on available commands.

Commands

• autocommit configure
• autocommit generate

autocommit configure

Configure commit message generation options

USAGE
  $ autocommit configure [--log-level debug|warn|error|info|trace]

GLOBAL FLAGS
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Configure commit message generation options

EXAMPLES
  $ autocommit configure

See code: src/commands/configure.ts

autocommit generate

Generate a commit message

USAGE
  $ autocommit generate [--log-level debug|warn|error|info|trace] [--style simple|detailed] [--typed]
    [--scoped] [--technical] [--tense present|past] [--emoji]

FLAGS
  --emoji           Include emoji in the commit message
  --scoped          Include scope in the commit message (e.g. core, auth, ui)
  --style=<option>  [default: simple] Specify the style of the commit message
                    <options: simple|detailed>
  --technical       Include technical details in the commit message
  --tense=<option>  [default: present] Specify the tense of the commit message
                    <options: present|past>
  --typed           Prefix commit message with type (e.g., feat, fix, docs)

GLOBAL FLAGS
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Generate a commit message

EXAMPLES
  $ autocommit generate

  $ autocommit generate --style detailed --typed --scoped --technical --tense past --emoji

See code: src/commands/generate.ts

License

This project is licensed under the MIT License - see the LICENSE file for details.