igit 2020.11.14

Interactive git and more

Igit - Interactive Git

TL;DR:

Igit is an interactive supplementary CLI to git for better git experience.

The Story:

For a long time I've been using a variety of aliases for git commands, some of which were custom and aimed to boosting my git productivity - so I've decided to package it into a product for others to use.

Main features:

1. Fast commits - add, commit & push, instantly.
2. Undo changes - cancel changes made to any file.
3. Branch hopping - move between branches, even if you have unstaged changes, without having to stage them.
4. Easy ignore - add files to ignore, sync with remote.
5. Interactivity - select and check instead of typing.

Installation

With pip:

pip install igit

Usage

Fast commits

Push / Commit your code in one command.

From:

git add .
git commit -m "commit message"
git push 

To:

igit up "commit message" 

Or:

You can also go through the whole interactive process:

Notes:

• If you don't specify a commit message it will default to 'fast commit'.
• Same goes for igit save - without pushing to remote.

Undo changes

Undo changes (unstaged) in a file or in all files.

# To undo changes in an unstaged changed file:
igit undo file_1.py 
# To pick a file just drop the file's name:
igit undo
# undo all changes
igit undo -all

Notes:

• Same goes for igit unstage with respect to added files.

Branch hopping

Move easily between local branches, enable hopping to move seamlessly even in case of unstaged changes.

# To change branches:
igit branch
# To change branches with unstaged changes:
igit branch --hopping_on 
# Create a new branch and change into it:
igit branch --create

Notes:

• When in hopping mode all change are stored to the git stash. You can use git stash list to see stashed changes and git stash pop to retrieve stashed changes

git ignore

Add files to ignore, create ignore files from templetes.

# To add files to .gitignore:
igit ignore
# To create a .gitignore:
igit ignore --create  

Notes:

• In case your local .gitignore is not in sync with your remote .gitignore you can use:

# Reset .gitignore:
igit ignore --reset 

And then push to remote - your current .gitignore will take effect.

diff

Select a file to view diff.

igit diff

Compatibility

igit is cross-platform → Windows, macOS, Linux

🤓 windows users will get best experience with windows terminal.

Built with

• click
• gitpython
• inquirer
• rich

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

Local dev environment (macOS / Linux)

• Clone this project
• cd into project directory
• Run: pipenv install
• Run: pipenv --venv
• Add bash alias:

alias igit='PYTHONPATH=<LOCAL GITSY PROJECT DIR> <PIPENV VENV PATH>/bin/python3 <LOCAL IGIT PROJECT DIR>/igit/cli.py'

• Now you can run igit from bash and code changes in local igit dir will apply.

License

MIT