You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): update installation and configuration details
- Added requirements for API keys from providers
- Included installation options using bun and shell script
- Revised quick start instructions for setting API keys
- Expanded configuration section with command line options
Copy file name to clipboardExpand all lines: README.md
+40-14Lines changed: 40 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,22 @@ AI-powered git auto-commit tool that intelligently groups your changes and gener
13
13
-**Pattern Filtering**: Exclude files using glob patterns with `--ignore`
14
14
-**Auto-Push**: Automatically pushes commits to remote (can be disabled)
15
15
16
+
## Requirements
17
+
18
+
- An API key from one of the supported AI providers:
19
+
-**OpenAI** — get one at [platform.openai.com/api-keys](https://platform.openai.com/api-keys)
20
+
-**Google Gemini** — get one at [aistudio.google.com/api-keys](https://aistudio.google.com/api-keys)
21
+
16
22
## Installation
17
23
24
+
### Option 1 — bun (requires [Bun](https://bun.sh) ≥ 1.0)
25
+
26
+
```bash
27
+
bun install -g @miselabanto/commita
28
+
```
29
+
30
+
### Option 2 — Shell script (no runtime required)
31
+
18
32
Downloads the correct pre-compiled binary for your OS and architecture directly from [GitHub Releases](https://github.com/misaelabanto/commita/releases):
2. Create a `.commita` file or set environment variables:
57
+
1. Set your API key and provider:
51
58
```bash
52
-
cp .commita.example .commita
53
-
# Edit .commita and add your API key (OpenAI or Gemini)
59
+
commita set OPENAI_API_KEY=sk-...
60
+
# or for Gemini:
61
+
commita set GEMINI_API_KEY=your-key
62
+
commita set PROVIDER=gemini
54
63
```
55
64
56
-
3. Navigate to your project and run:
65
+
2. Navigate to your project and run:
57
66
```bash
58
67
commita --all
59
68
```
60
69
61
70
## Configuration
62
71
63
-
Create a `.commita` file in your project root or use environment variables with the `COMMITA_` prefix.
72
+
### `commita set` (recommended)
73
+
74
+
Set config values from the command line. By default values are saved globally to `~/.commita`. Use `--local` to save them to `.commita` in the current project instead.
75
+
76
+
```bash
77
+
# Set values directly
78
+
commita set PROVIDER=openai
79
+
commita set MODEL=gpt-4o-mini
80
+
81
+
# Omit the value to be prompted securely (input is hidden for API keys)
82
+
commita set OPENAI_API_KEY
83
+
commita set GEMINI_API_KEY
84
+
85
+
# Save to the current project only
86
+
commita set PROVIDER=gemini --local
87
+
```
88
+
89
+
### `.commita` file (manual)
64
90
65
-
### `.commita` file format (key=value):
91
+
You can also create or edit a `.commita` file directly. Project-level (`./.commita`) takes precedence over global (`~/.commita`).
0 commit comments