Hands0me NPM | npm.io

Setup

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

Install hands0me:
```
npm install -g hands0me
```
Retrieve your API key from OpenAI
Note: If you haven't already, you'll have to create an account and set up billing.
Set the key so hands0me can use it:
```
hands0me config set OPENAI_KEY=<your token>
```
This will create a .hands0me file in your home directory.

Upgrading

Check the installed version with:

hands0me --version

If it's not the latest version, run:

npm update -g hands0me

Usage

CLI mode

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

git add <files...>
hands0me

hands0me 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:

hands0me --all # or -a

👉 Tip: Use the aic alias if hands0me 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:

hands0me --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 hands0me to format the commit message according to the Conventional Commits specification:

hands0me --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 hands0me 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:

hands0me hook install

Uninstall

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

hands0me 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"
hands0me 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:

hands0me config get <key>

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

hands0me config get OPENAI_KEY

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

hands0me config get OPENAI_KEY generate

Setting a configuration value

To set a configuration option, use the command:

hands0me config set <key>=<value>

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

hands0me config set OPENAI_KEY=<your-api-key>

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

hands0me config set OPENAI_KEY=<your-api-key> generate=3 locale=en

Options

OPENAI_KEY

Required

The OpenAI API key. You can retrieve it from OpenAI 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):

hands0me config set proxy=

model

Default: gpt-3.5-turbo

The Chat Completions (/v1/chat/completions) model to use. Consult the list of models available in the OpenAI Documentation.

Tip: If you have access, try upgrading to gpt-4 for next-level code analysis. It can handle double the input size, but comes at a higher cost. Check out OpenAI's website to learn more.