Skip to content

aalbrightpdx/githelper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

githelper banner

πŸ› οΈ A smart, friendly CLI assistant for safely staging, committing, and pushing Git changes β€” with built-in teaching moments and power-user flags.


✨ What It Does

  • Detects and stages untracked or modified files
  • Prompts before committing and pushing
  • Explains detached HEAD state when detected
  • Prevents commits during merge conflicts
  • Shows diff preview before commit (optional)
  • Flags to suppress prompts and explanations

🧰 Clone the GitHelper repository to your system:

Open your terminal and run:

git clone git@github.com:aalbrightpdx/githelper.git

Or, if you prefer HTTPS:

git clone https://github.com/aalbrightpdx/githelper.git
cd githelper

🧰 Install

In the project directory:

pipx install .

πŸš€ Usage

Once installed, from any directory run:

githelper              # Start interactive assistant
githelper --yes        # Auto-confirm everything
githelper --no-explain # Skip explanations
githelper -h           # Show help

Example workflow:

πŸ“¦ Remote repository detected: git@github.com:your/repo.git
βœ… Is this the correct repository you want to update? [y/n]: y
πŸ” Checking git status...
βœ… Stage all changes and continue? [y/n]: y
πŸ“ Enter your commit message: Add CLI help flags
πŸš€ Ready to push to GitHub? [y/n]: y
πŸŽ‰βœ… All done! Your changes are pushed!

Uninstall

pip uninstall githelper

πŸ’‘ Requirements

  • Python 3.6+
  • Git installed and available in your system PATH

πŸ“œ License

MIT β€” free to use, modify, and share.

About

A tiny Python tool that makes Git commits and pushes much easier!

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages