Skip to content

Commit

Permalink
Merge pull request #51 from tak-bro/feature/update-doc
Browse files Browse the repository at this point in the history 
Feature/update doc
  • Loading branch information
@tak-bro
tak-bro authored Jun 30, 2024
2 parents 13947b2 + 35fbfa9 commit 8cdf953
Show file tree
Hide file tree
Showing 6 changed files with 4,379 additions and 5,193 deletions.
113 changes: 71 additions & 42 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -304,40 +304,41 @@ aicommit2 config set OPENAI_KEY=<your-api-key> generate=3 locale=en

## Options

| Option | Default | Description |
|-------------------|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| `OPENAI_KEY` | N/A | The OpenAI API key |
| `OPENAI_MODEL` | `gpt-3.5-turbo` | The OpenAI Model to use |
| `OPENAI_URL` | `https://api.openai.com` | The OpenAI URL |
| `OPENAI_PATH` | `/v1/chat/completions` | The OpenAI request pathname |
| `ANTHROPIC_KEY` | N/A | The Anthropic API key |
| `ANTHROPIC_MODEL` | `claude-3-haiku-20240307` | The Anthropic Model to use |
| `GEMINI_KEY` | N/A | The Gemini API key |
| `GEMINI_MODEL` | `gemini-1.5-flash-latest` | The Gemini Model |
| `MISTRAL_KEY` | N/A | The Mistral API key |
| `MISTRAL_MODEL` | `mistral-tiny` | The Mistral Model to use |
| `CODESTRAL_KEY` | N/A | The Codestral API key | |
| `COHERE_KEY` | N/A | The Cohere API Key |
| `COHERE_MODEL` | `command` | The identifier of the Cohere model |
| `GROQ_KEY` | N/A | The Groq API Key |
| `GROQ_MODEL` | `gemma-7b-it` | The Groq model name to use |
| `HUGGING_COOKIE` | N/A | The HuggingFace Cookie string |
| `HUGGING_MODEL` | `mistralai/Mixtral-8x7B-Instruct-v0.1` | The HuggingFace Model to use |
| `CLOVAX_COOKIE` | N/A | The Clova X Cookie string |
| `OLLAMA_MODEL` | N/A | The Ollama Model. It should be downloaded your local |
| `OLLAMA_HOST` | `http://localhost:11434` | The Ollama Host |
| `OLLAMA_TIMEOUT` | `100_000` ms | Request timeout for the Ollama |
| `OLLAMA_STREAM` | N/A | Whether to make stream requests (**experimental feature**) |
| `locale` | `en` | Locale for the generated commit messages |
| `generate` | `1` | Number of commit messages to generate |
| `type` | `conventional` | Type of commit message to generate |
| `proxy` | N/A | Set a HTTP/HTTPS proxy to use for requests(only **OpenAI**) |
| `timeout` | `10_000` ms | Network request timeout |
| `max-length` | `50` | Maximum character length of the generated commit message |
| `max-tokens` | `200` | The maximum number of tokens that the AI models can generate (for **Open AI, Anthropic, Gemini, Mistral**) |
| `temperature` | `0.7` | The temperature (0.0-2.0) is used to control the randomness of the output (for **Open AI, Anthropic, Gemini, Mistral**) |
| `prompt` | N/A | Additional prompt to let users fine-tune provided prompt |
| `logging` | `false` | Whether to log AI responses for debugging (true or false) |
| Option | Default | Description |
|-------------------|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| `OPENAI_KEY` | N/A | The OpenAI API key |
| `OPENAI_MODEL` | `gpt-3.5-turbo` | The OpenAI Model to use |
| `OPENAI_URL` | `https://api.openai.com` | The OpenAI URL |
| `OPENAI_PATH` | `/v1/chat/completions` | The OpenAI request pathname |
| `ANTHROPIC_KEY` | N/A | The Anthropic API key |
| `ANTHROPIC_MODEL` | `claude-3-haiku-20240307` | The Anthropic Model to use |
| `GEMINI_KEY` | N/A | The Gemini API key |
| `GEMINI_MODEL` | `gemini-1.5-pro-latest` | The Gemini Model |
| `MISTRAL_KEY` | N/A | The Mistral API key |
| `MISTRAL_MODEL` | `mistral-tiny` | The Mistral Model to use |
| `CODESTRAL_KEY` | N/A | The Codestral API key |
| `CODESTRAL_MODEL` | `codestral-latest` | The Codestral Model to use |
| `COHERE_KEY` | N/A | The Cohere API Key |
| `COHERE_MODEL` | `command` | The identifier of the Cohere model |
| `GROQ_KEY` | N/A | The Groq API Key |
| `GROQ_MODEL` | `gemma-7b-it` | The Groq model name to use |
| `HUGGING_COOKIE` | N/A | The HuggingFace Cookie string |
| `HUGGING_MODEL` | `mistralai/Mixtral-8x7B-Instruct-v0.1` | The HuggingFace Model to use |
| `CLOVAX_COOKIE` | N/A | The Clova X Cookie string |
| `OLLAMA_MODEL` | N/A | The Ollama Model. It should be downloaded your local |
| `OLLAMA_HOST` | `http://localhost:11434` | The Ollama Host |
| `OLLAMA_TIMEOUT` | `100_000` ms | Request timeout for the Ollama |
| `OLLAMA_STREAM` | N/A | Whether to make stream requests (**experimental feature**) |
| `locale` | `en` | Locale for the generated commit messages |
| `generate` | `1` | Number of commit messages to generate |
| `type` | `conventional` | Type of commit message to generate |
| `proxy` | N/A | Set a HTTP/HTTPS proxy to use for requests(only **OpenAI**) |
| `timeout` | `10_000` ms | Network request timeout |
| `max-length` | `50` | Maximum character length of the generated commit message |
| `max-tokens` | `200` | The maximum number of tokens that the AI models can generate (for **Open AI, Anthropic, Gemini, Mistral, Codestral**) |
| `temperature` | `0.7` | The temperature (0.0-2.0) is used to control the randomness of the output (for **Open AI, Anthropic, Gemini, Mistral, Codestral**) |
| `prompt` | N/A | Additional prompt to let users fine-tune provided prompt |
| `logging` | `false` | Whether to log AI responses for debugging (true or false) |

> **Currently, options are set universally. However, there are plans to develop the ability to set individual options in the future.**
Expand All @@ -348,6 +349,7 @@ aicommit2 config set OPENAI_KEY=<your-api-key> generate=3 locale=en
| **Anthropic Claude** | ✓ | ✓ | ✓ | | | ✓ | ✓ | ✓ | ✓ |
| **Gemini** | ✓ | ✓ | ✓ | | | ✓ | ✓ | ✓ | ✓ |
| **Mistral AI** | ✓ | ✓ | ✓ | | ✓ | ✓ | ✓ | ✓ | ✓ |
| **Codestral** | ✓ | ✓ | ✓ | | ✓ | ✓ | ✓ | ✓ | ✓ |
| **Cohere** | ✓ | ✓ | ✓ | | | ✓ | ✓ | ✓ | ✓ |
| **Groq** | ✓ | ✓ | ✓ | | ✓ | ✓ | | | ✓ |
| **Huggingface** | ✓ | ✓ | ✓ | | ✓ | ✓ | | | ✓ |
Expand Down Expand Up @@ -562,11 +564,11 @@ The Gemini API key. If you don't have one, create a key in [Google AI Studio](ht

##### GEMINI_MODEL

Default: `gemini-1.5-flash-latest`
Default: `gemini-1.5-pro-latest`

Supported:
- `gemini-1.5-pro-latest`
- `gemini-1.5-flash-latest`
- `gemini-pro`

> The models mentioned above are subject to change.
Expand All @@ -576,12 +578,6 @@ Supported:

The Mistral API key. If you don't have one, please sign up and subscribe in [Mistral Console](https://console.mistral.ai/).

##### CODESTRAL_KEY

The Codestral API key. If you don't have one, please sign up and subscribe in [Mistral Console](https://console.mistral.ai/codestral).

> To use a Codestral model, the `MISTRAL_MODEL` value needs to be set to `codestral-latest` (or `codestral-2405`).
##### MISTRAL_MODEL

Default: `mistral-tiny`
Expand All @@ -606,6 +602,21 @@ Supported:

> The models mentioned above are subject to change.
### CODESTRAL

##### CODESTRAL_KEY

The Codestral API key. If you don't have one, please sign up and subscribe in [Mistral Console](https://console.mistral.ai/codestral).

##### CODESTRAL_MODEL

Default: `codestral-latest`

Supported:
- `codestral-latest`
- `codestral-2405`

> The models mentioned above are subject to change.
### Cohere

Expand Down Expand Up @@ -760,3 +771,21 @@ If this project has been helpful to you, I would greatly appreciate it if you co
## Contributing

If you want to help fix a bug or implement a feature in [Issues](https://github.com/tak-bro/aicommit2/issues), checkout the [Contribution Guide](CONTRIBUTING.md) to learn how to setup and test the project.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/eltociear"><img src="https://avatars.githubusercontent.com/eltociear" width="100px;" alt=""/><br /><sub><b>@eltociear</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=eltociear" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/ubranch"><img src="https://avatars.githubusercontent.com/ubranch" width="100px;" alt=""/><br /><sub><b>@ubranch</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=ubranch" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/bhodrolok"><img src="https://avatars.githubusercontent.com/bhodrolok" width="100px;" alt=""/><br /><sub><b>@bhodrolok</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=bhodrolok" title="Code">💻</a></td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
Loading

0 comments on commit 8cdf953

Please sign in to comment.