🦇 Batman Git CLI Assistant

Where to run Batman

Run Batman from inside the project folder you are working on, not from a general folder such as Downloads. Use PowerShell or Command Prompt:

cd C:\Projects\my-app
batman doctor

Use batman doctor first if you are unsure whether you are in the correct folder.

A beginner-friendly Git command helper that makes everyday Git workflows safe, simple, and stress-free.

📦 Installation

Open PowerShell or Command Prompt and run:

npm install -g batman-commands

🚀 Quick Start

Navigate to your project folder and run:

batman

To see all available commands:

batman help

🛠️ Commands

batman safe-push "message" — The Safe Sync

Safely commit and push your work to GitHub without overwriting your teammates' changes.

batman safe-push "Created the login screen"

Exclude specific files from the push using --skip:

# Skip a single file
batman safe-push "Updated homepage" --skip "src/config.js"

# Skip multiple files
batman safe-push "Updated homepage" --skip "src/config.js" --skip "package-lock.json"

Skipped files stay as local uncommitted changes while everything else gets committed and pushed.

What it does under the hood:

1. Scans files for accidentally included passwords or large files
2. Commits (saves) your work locally
3. If --skip is used, excludes the specified files from the commit
4. Pulls the latest code from GitHub using rebase
5. Pushes the clean, combined work to GitHub

batman conflict — View Conflicts

See the differences when a merge conflict occurs.

batman conflict

batman resolve — Resolve Conflicts

Interactively decide which code to keep when a conflict is detected.

batman resolve

Press 1 to keep your team's code, or 2 to keep your local code.

batman continue — Resume After Resolving

After resolving all conflicts, resume and complete the push.

batman continue

batman doctor — Project Checkup

Check whether the current folder is ready and view a detailed project status report.

batman doctor

batman incoming — View Team Changes

Show files changed by other team members that have not yet been downloaded to your computer.

batman incoming

batman open — Open in VS Code

Open the current project in VS Code.

batman open

batman squash — Clean Up Commits

Merge multiple small local commits into one clean commit before pushing (avoids "Rebase Hell").

batman squash

batman scan — Safety Shield

Manually scan your changes for accidentally included secrets (passwords, API keys) or oversized files.

batman scan

Note: batman safe-push runs this automatically.

batman verify — Health Checker

Run a build and test check before pushing to make sure your code compiles and passes tests.

batman verify

Runs npm run build and npm run test internally.

batman rescue — Emergency Reset

Reset your local repository to match GitHub when your Git history is completely out of sync.

batman rescue

⚠️ Use only when normal push/pull operations are broken. It will backup your work first.

batman sub-sync — Submodule Linker

Re-sync Git submodules when they appear empty, outdated, or missing.

batman sub-sync

🔄 Update

npm update -g batman-commands

❌ Uninstall

npm uninstall -g batman-commands

📄 License

MIT © Mohamed