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
Copy file name to clipboardExpand all lines: README.md
+18-11Lines changed: 18 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,24 +4,31 @@ Offline AI agent for Git workflowsβvoice-dictated commits, smart summaries, an
4
4
5
5
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.
6
6
7
-
## β¨ Features (MVP)
8
-
- π Auto-generate commit messages from diffs using local AI (gpt-oss-20b).
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)
18
22
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.
20
27
21
28
## π 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.
25
32
26
33
Contributions welcome! See Issues for "good first issue" tags.
0 commit comments