Aicg NPM | npm.io

Setup

The minimum supported version of Node.js is the latest v14. Check your Node.js version with node --version.

Install aicg:
```
npm install -g aicg
```
Retrieve your API key from GROQ- --title <title>: Custom title for the pull request. If not provided, a default title will be generated.
Note: If you haven't already, you'll have to create an account and set up billing.
Set the key so aicg can use it:
```
aicg config set GROQ_API_KEY=<your token>
```
This will create a .aicg file in your home directory.

Upgrading

Check the installed version with:

aicg --version

If it's not the latest version, run:

npm update -g aicg

Usage

CLI mode

You can call aicg directly to generate a commit message for your staged changes:

git add <files...>
aicg

aicg passes down unknown flags to git commit, so you can pass in commit flags.

For example, you can stage all changes in tracked files with as you commit:

aicg --all # or -a

👉 Tip: Use the aic alias if aicg is too long for you.

Generate multiple recommendations

Sometimes the recommended commit message isn't the best so you want it to generate a few to pick from. You can generate multiple commit messages at once by passing in the --generate <i> flag, where 'i' is the number of generated messages:

aicg --generate <i> # or -g <i>

Warning: this uses more tokens, meaning it costs more.

Generating Conventional Commits

If you'd like to generate Conventional Commits, you can use the --type flag followed by conventional. This will prompt aicg to format the commit message according to the Conventional Commits specification:

aicg --type conventional # or -t conventional

This feature can be useful if your project follows the Conventional Commits standard or if you're using tools that rely on this commit format.

Git hook

You can also integrate aicg with Git via the prepare-commit-msg hook. This lets you use Git like you normally would, and edit the commit message before committing.

Install

In the Git repository you want to install the hook in:

aicg hook install

Uninstall

In the Git repository you want to uninstall the hook from:

aicg hook uninstall

Usage

Stage your files and commit:
```
git add <files...>
git commit # Only generates a message when it's not passed in
```
If you ever want to write your own message instead of generating one, you can simply pass one in: git commit -m "My message"
aicg will generate the commit message for you and pass it back to Git. Git will open it with the configured editor for you to review/edit it.
Save and close the editor to commit!

Configuration

Reading a configuration value

To retrieve a configuration option, use the command:

aicg config get <key>

For example, to retrieve the API key, you can use:

aicg config get GROQ_API_KEY

You can also retrieve multiple configuration options at once by separating them with spaces:

aicg config get GROQ_API_KEY generate

Setting a configuration value

To set a configuration option, use the command:

aicg config set <key>=<value>

For example, to set the API key, you can use:

aicg config set GROQ_API_KEY=<your-api-key>

You can also set multiple configuration options at once by separating them with spaces, like

aicg config set GROQ_API_KEY=<your-api-key> generate=3 locale=en

Options

GROQ_API_KEY

Required

The GROQ API key. You can retrieve it from GROQ API Keys page.

locale

Default: en

The locale to use for the generated commit messages. Consult the list of codes in: https://wikipedia.org/wiki/List_of_ISO_639-1_codes.

generate

Default: 1

The number of commit messages to generate to pick from.

Note, this will use more tokens as it generates more results.

proxy

Set a HTTP/HTTPS proxy to use for requests.

To clear the proxy option, you can use the command (note the empty value after the equals sign):

aicg config set proxy=

model

Default: mixtral-8x7b-32768

Use the following command to select different models with aicg and save the selection:

aicg models select

This command configures and saves your selection so when you run aicg next time, it will use the selected model.

Alternatively, you can override the selected model for a specific time using:

aicg -k <model-id>

timeout

The timeout for network requests in milliseconds.

Default: 10000 (10 seconds)

aicg config set timeout=20000 # 20s

max-length

The maximum character length of the generated commit message.

Default: 50

aicg config set max-length=100

type

Default: "" (Empty string)

The type of commit message to generate. Set this to "conventional" to generate commit messages that follow the Conventional Commits specification:

aicg config set type=conventional

You can clear this option by setting it to an empty string:

aicg config set type=

PRGen

Usage

You can call aicg prgen to generate a pull request description based on your commit messages: The generated pull request description and title are saved in a JSON file located at .aicg/pr.json. This allows you to easily access, review, and edit the generated content before submitting your pull request.

--from <commit-id>: (Required) Specify the starting commit.
--to <commit-id>: Specify the ending commit (default: latest commit).
--current-user-only or -u: Filter commits for the current user only (default: false).

aicg prgen --from <commit-id> [--to <commit-id>] [--current-user-only]

Examples:

Generate PR description for all commits from a specific commit (default behavior):
```
aicg prgen --from abc123
```
Generate PR description for commits between two specific commits:
```
aicg prgen --from abc123 --to def456
```
Generate PR description for only the current user's commits from a specific commit:
```
aicg prgen --from abc123 --current-user-only
```
Using the short alias for current user only:
```
aicg prgen --from abc123 -u
```

Note: The --from flag is required. By default, aicg prgen includes commits from all users. Use the --current-user-only or -u flag to filter commits for the current user only.