Automatic GitHub commit bot that logs developer activity.
Project description
๐ AutoCommitBot (v1.2.6)
Maintain a professional GitHub presence with AI-powered automation and built-in security.
AutoCommitBot is an intelligent, cross-platform CLI tool designed for developers who want to maintain a consistent contribution history without the manual overhead. It monitors your local repositories, generates meaningful commit messages using Google's Gemini AI, and manages the full Git lifecycle automatically.
๐ฅ๏ธ Preview
๐ Why AutoCommitBot?
- AI Commit Messages โ Generates meaningful, context-aware commits instead of generic updates
- Security (Secret Shield) โ Prevents accidental exposure of sensitive files and credentials
- Natural Activity Mode โ Simulates realistic developer commit patterns
- Backup & Restore โ Enables complete rollback of local and remote states
- Automated Execution โ Runs seamlessly in the background on system logon
โจ Features
Core Capabilities
- AI Commit Generation โ Context-aware commit messages using Gemini with model fallback
- Security Layer (Secret Shield) โ Automatic protection against sensitive file and credential exposure
- Scheduling Engine โ Supports logon, fixed-time, and natural activity-based execution
- Backup & Restore โ Pre-commit snapshots with full local and remote rollback capability
- Dashboard & Analytics โ CLI-based insights into commit history and activity
- Execution Reliability โ Built-in retry logic, conflict handling, and network checks and much more... Check Below ๐๐ป
๐ View Full Feature Breakdown
โ๏ธ Setup & Configuration
- GitHub Repository Discovery via API
- Interactive multi-select repo setup
- Base folder configuration
- Automatic cloning of missing repos
- Git authentication verification
- Backward navigation during setup
๐ Scheduling System
- Logon trigger (Windows Task Scheduler) โ 5/day cap on random activity only; real code changes always push through
- Fixed-time daily scheduling
- Randomized daily execution (9 AM โ 11 PM)
- Natural Activity Mode (probabilistic commits with 48h enforcement)
- Runs with highest privileges
- Works on battery power
๐ Commit Engine
- Smart change detection across repositories
- Commits real user changes with descriptive messages
- Generates fallback activity commits when idle
- Automatic pull โ merge โ push workflow
- Push retry logic on failure
๐ค AI Commit System
- Gemini AI integration for commit messages
- AI Key Validation โ Real-time verification of your API key during setup
- Model fallback chain: 2.5 Flash โ 2.0 Flash โ 1.5 Flash โ Pro
- Diff truncation for large inputs (8000 chars)
๐พ Backup & Restore
- ZIP snapshot before every commit
- Configurable backup retention (
config-backup) - Restore command with snapshot selection
- Automatic GitHub rollback via force push
- Clear all backups on demand (
clear-backups)
๐ Dashboard & Management
- Dashboard with last 50 commits (rich table view)
- Commit classification (User vs Activity)
- Status command for tracked repos
- Add/remove repositories dynamically
- Persistent history tracking (500 entries)
- Clean uninstall command โ removes scheduler task before uninstalling
- Version check command โ shows installed version and detects available updates
๐ Reliability Layer
- Internet availability check (retry up to 2 minutes)
- Automatic admin privilege escalation
- Resilient Git operations with fallback handling
โ๏ธ How It Works
- Detects changes in tracked repositories
- Syncs with remote using
git pull - Analyzes
git diffusing Gemini AI - Generates a contextual commit message
- Runs security checks (Secret Shield)
- Commits and pushes changes
- Stores a backup snapshot
All of this runs automatically in the background.
๐ Getting Started
Prerequisites
- Python 3.8+
- Git installed and configured
- (Recommended) Gemini API Key โ https://aistudio.google.com/app/apikey
๐ฆ Installation
Option 1: From Source
git clone https://github.com/RohitKSahoo/auto-commit-bot.git
cd auto-commit-bot
pip install -e .
Option 2: Via pip (Recommended)
pip install autocommitbot
๐ ๏ธ Usage
All commands follow the pattern: autocommit <command>
Run
autocommit <command> --helpfor full details on any command.
โ๏ธ Setup & Config
| Command | What it does |
|---|---|
autocommit setup |
First-time wizard, or edit repos / schedule / AI |
autocommit config-backup <days> |
Set how long backups are kept |
Tip: Running
autocommit setupagain on a configured machine shows a short menu so you can update just one section (Repositories, Schedule, or AI key) without repeating the full wizard.
๐ Repositories
| Command | What it does |
|---|---|
autocommit add [path] |
Track a new local git repo |
autocommit remove |
Stop tracking a repo |
autocommit status |
List all tracked repos |
๐ Automation
| Command | What it does |
|---|---|
autocommit run |
Commit & push all changes now |
autocommit enable |
Register the Windows auto-start task |
autocommit disable |
Remove the Windows auto-start task |
๐ History & System
| Command | What it does |
|---|---|
autocommit dashboard |
View commit history & stats |
autocommit restore |
Roll back a bot commit from snapshot |
autocommit clear-backups |
Delete all backup snapshots to free disk space |
autocommit version |
Check installed version & updates |
autocommit uninstall |
Remove scheduler task then pip uninstall |
โ ๏ธ Notes
- Automation runs only on tracked repositories
restoreperforms a force push โ rewrites remote history, use with cautionrunis for manual triggering, not regular use- Internet connection required for push, version check, and AI commit messages
- On Logon mode caps random activity at 5 per calendar day โ real code changes always push through, even after the cap is reached
- Always use
autocommit uninstallinstead ofpip uninstalldirectly โ running pip uninstall alone will leave an orphaned task in Windows Task Scheduler that silently fails on every trigger
๐ Staying Up to Date
Run the following command to check your current version and see if a newer release is available:
autocommit version
Example output when up to date:
AutoCommitBot v1.2.6
Checking for updates...
โ You are on the latest version (1.2.6).
๐ New in this version (v1.2.6):
โข "What's New" section now displays correctly after pip install
Example output when an update is available:
AutoCommitBot v1.2.5
Checking for updates...
โก New version available: 1.2.6 (you have 1.2.5)
๐ What's New in v1.2.6:
โข "What's New" section now displays correctly after pip install
Run to update: pip install --upgrade autocommitbot
To update manually at any time:
pip install --upgrade autocommitbot
๐ Security Notes
- Your code is not stored externally (only analyzed for commit messages)
- Sensitive files are automatically excluded via
.gitignore restoreuses force push โ use with caution
๐ Support & Contributions
- Report issues: https://github.com/RohitKSahoo/auto-commit-bot/issues
- Contributions welcome (see
CONTRIBUTING.md) - Additional docs in
/docs
๐ค Maintainer
Maintained by @RohitKSahoo
๐ License
This project is licensed under the GNU General Public License v3.0.
You are free to use, modify, and distribute this software under the terms of the license. Any derivative work must also be open-sourced under GPL v3.
See the LICENSE file for full details.
๐งพ TL;DR
AutoCommitBot is a smart Git automation layer with AI, security, and recovery built in. itโs a smart Git workflow layer with AI, security, and recovery built in.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file autocommitbot-1.2.6.tar.gz.
File metadata
- Download URL: autocommitbot-1.2.6.tar.gz
- Upload date:
- Size: 27.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
273012da6e098f1a3f58045805a10c9c301f68bf3c3bf1394509dcd30a6db871
|
|
| MD5 |
f77f1d1f9ea83e98627fe8eb4c4a218c
|
|
| BLAKE2b-256 |
a7e983c4980efa7ea9fb99c9686ad070de71bf6f3340f94dfab02f0119dc4fd5
|
File details
Details for the file autocommitbot-1.2.6-py3-none-any.whl.
File metadata
- Download URL: autocommitbot-1.2.6-py3-none-any.whl
- Upload date:
- Size: 27.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f7192a3565b66f0b6c642767e073bf6733f80bdcd08703f664d7dd80e63d6f0
|
|
| MD5 |
94e6ee0e5cf68123860ccef0275e1b01
|
|
| BLAKE2b-256 |
86ee059df70b32b7b540bf1fc940c9869014e59beb1cd48c6905c446a95723f9
|