Skip to main content

Automatic GitHub commit bot that logs developer activity.

Project description

🚀 AutoCommitBot (v1.2.3)

Python Version License GitHub activity

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

AutoCommitBot CLI


🌟 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)
  • 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

📊 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

  1. Detects changes in tracked repositories
  2. Syncs with remote using git pull
  3. Analyzes git diff using Gemini AI
  4. Generates a contextual commit message
  5. Runs security checks (Secret Shield)
  6. Commits and pushes changes
  7. Stores a backup snapshot

All of this runs automatically in the background.


🚀 Getting Started

Prerequisites


📦 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> --help for 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 setup again 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 version Check installed version & updates
autocommit uninstall Remove scheduler task then pip uninstall

⚠️ Notes

  • Automation runs only on tracked repositories
  • restore performs a force push — rewrites remote history, use with caution
  • run is for manual triggering, not regular use
  • Internet connection required for push, version check, and AI commit messages
  • Always use autocommit uninstall instead of pip uninstall directly — 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.1.6
Checking for updates...
✔ You are on the latest version (1.1.6).

Example output when an update is available:

AutoCommitBot  v1.1.5
Checking for updates...
⚡ New version available: 1.1.6 (you have 1.1.5)
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
  • restore uses force push — use with caution

🆘 Support & Contributions


👤 Maintainer

Maintained by @RohitKSahoo


📄 License

Licensed under the MIT License. See LICENSE for details.


🧾 TL;DR

AutoCommitBot is not just automation— it’s a smart Git workflow layer with AI, security, and recovery built in.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autocommitbot-1.2.3.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autocommitbot-1.2.3-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file autocommitbot-1.2.3.tar.gz.

File metadata

  • Download URL: autocommitbot-1.2.3.tar.gz
  • Upload date:
  • Size: 23.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for autocommitbot-1.2.3.tar.gz
Algorithm Hash digest
SHA256 1076e81c840c84bf4216df65549dd8b5ec515cb67b465b6c0582e15746d7b262
MD5 1ba409a88af11b26bdc10937beb81406
BLAKE2b-256 ef77a98b8025a5605042e5f17c9b322938590dd83db6b199c711974bc2665152

See more details on using hashes here.

File details

Details for the file autocommitbot-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: autocommitbot-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 22.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for autocommitbot-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f34058619dd82f155eb45ec85666e7f4328fe663358ba24b32ba2a5b46bc5d9d
MD5 91e0019f324ff6798c1071f5ec66ce50
BLAKE2b-256 9be168d52a0dccf5b3b3819be0f35e5a2d55cc7c125bbbec4eecc3dc4eb05be4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page