Skip to content

Commit d65eccd

Browse files
Added new flag info into README
1 parent a602f2b commit d65eccd

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Looking to contribute? Check out:
2929

3030
**AI-Powered Commit Messages** - Automatically generate meaningful commit messages
3131
🔄 **Multiple LLM Support** - Choose between Google Gemini, Grok, Claude, ChatGPT, or Ollama (local)
32+
🧪 **Dry Run Mode** - Preview prompts without making API calls
3233
📝 **Context-Aware** - Analyzes staged and unstaged changes
3334
📋 **Auto-Copy to Clipboard** - Generated messages are automatically copied for instant use
3435
🎛️ **Interactive Review Flow** - Accept, regenerate with new styles, or open the message in your editor before committing
@@ -112,6 +113,27 @@ Or if running from source:
112113
go run cmd/commit-msg/main.go .
113114
```
114115

116+
### Preview Mode (Dry Run)
117+
118+
Preview what would be sent to the LLM without making an API call:
119+
120+
```bash
121+
commit . --dry-run
122+
```
123+
124+
This displays:
125+
- The LLM provider that would be used
126+
- The exact prompt that would be sent
127+
- File statistics and change summary
128+
- Estimated token count
129+
- All without consuming API credits or sharing data
130+
131+
Perfect for:
132+
- 🐛 **Debugging** - See exactly what prompt is being sent
133+
- 💰 **Cost Control** - Review before consuming API credits
134+
- 🔒 **Privacy** - Verify what data would be shared with external APIs
135+
- 🧪 **Development** - Test prompt changes without API calls
136+
115137
### Setup LLM and API Key
116138

117139
```bash

0 commit comments

Comments
 (0)