Skip to content

Commit 49fcedf

Browse files
authored
Update README.md
1 parent c3bc61a commit 49fcedf

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

β€ŽREADME.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,31 @@ Offline AI agent for Git workflowsβ€”voice-dictated commits, smart summaries, an
44

55
Inspired by agentic engineering: No more stalled prompts or manual loops. Just dictate "Commit vibe: fixed auth bug," and it generates summaries with local gpt-oss-20b, verifies diffs, and pushes if ready.
66

7-
## ✨ Features (MVP)
8-
- πŸ“ Auto-generate commit messages from diffs using local AI (gpt-oss-20b).
9-
- πŸ” Vibe checks: Ensures tasks complete (e.g., "Did I write code? Verify output").
10-
- 🎀 Voice dictation integration (coming soon: Wispr Flow or macOS native).
11-
- βš™οΈ Extensible
12-
- Zero config: Runs in any Git repo via CLI.
7+
## ✨ Features
8+
- πŸ“ Auto-generate commit messages from recent commits (last 10) using local AI (gpt-oss-20b).
9+
- πŸ” Vibe checks: Validates summary length and optionally auto-commits.
10+
- 🎀 Voice dictation integration with macOS native Speech framework (transcribe vibes hands-free).
11+
- βš™οΈ Extensible CLI with flags for mock mode (testing without AI) and auto-commit.
12+
- Zero config: Runs in any Git repo.
1313

1414
## πŸš€ Quick Start
1515
1. Clone: `git clone https://github.com/ClayWarren/VibeCommit.git`
1616
2. Build: `swift build`
17-
3. Run: `./.build/debug/VibeCommit --summarize` (in a Git repo)
17+
3. Run examples (in a Git repo):
18+
- Basic summary: `swift run VibeCommit --summarize`
19+
- With voice input: `swift run VibeCommit --summarize --voice`
20+
- Mock mode for testing: `swift run VibeCommit --summarize --voice --mock`
21+
- Auto-commit: `swift run VibeCommit --summarize --autoCommit` (prompts for confirmation)
1822

19-
Install gpt-oss-20b separately via Hugging Face for AI features.
23+
### Setup Notes
24+
- **AI Features**: Install gpt-oss-20b via Hugging Face for real summaries (skip with `--mock`). Requires Python 3+ with `transformers` library: `pip install transformers`. The model will auto-download on first use.
25+
- **Voice Permissions (macOS)**: On first run with `--voice`, grant microphone and speech recognition access via System Settings > Privacy & Security. If no prompt appears, reset with `tccutil reset Microphone` and `tccutil reset SpeechRecognition` in Terminal.
26+
- **Dependencies**: Swift 6.2+, Git, Python for AI bridge.
2027

2128
## πŸ“… Roadmap
22-
- Phase 1: Core CLI with Git hooks and basic AI summaries.
23-
- Phase 2: Voice input and agent completions.
24-
- Future: Integrations (visual diffs, MCP for Claude fallback if local fails).
29+
- Phase 1: Core CLI with Git hooks and basic AI summaries. βœ…
30+
- Phase 2: Voice input and agent completions. βœ…
31+
- Future: Integrations (visual diffs, MCP for Claude fallback if local fails), full Git push automation.
2532

2633
Contributions welcome! See Issues for "good first issue" tags.
2734

0 commit comments

Comments
Β (0)