Skip to content

Commit 81227b7

Browse files
Documentation Added for --auto flag
1 parent ab5c917 commit 81227b7

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,36 @@ Perfect for:
134134
- 🔒 **Privacy** - Verify what data would be shared with external APIs
135135
- 🧪 **Development** - Test prompt changes without API calls
136136

137+
### Auto Commit Mode
138+
139+
Automatically commit with the generated message without manual confirmation:
140+
141+
```bash
142+
commit . --auto
143+
```
144+
145+
This will:
146+
- Generate the commit message using your configured LLM
147+
- Automatically execute `git commit` with the generated message
148+
- Skip the interactive review and manual confirmation step
149+
150+
**Note**: The `--auto` flag cannot be combined with `--dry-run`. Dry run mode takes precedence and will only preview without committing.
151+
152+
**Platform Support**: Works on Linux, macOS, and Windows.
153+
154+
### Combining Flags
155+
156+
```bash
157+
# Preview only (no commit, no API call)
158+
commit . --dry-run
159+
160+
# Generate and auto-commit
161+
commit . --auto
162+
163+
# Generate with interactive review (default behavior)
164+
commit .
165+
```
166+
137167
### Setup LLM and API Key
138168

139169
```bash

0 commit comments

Comments
 (0)