https://github.com/montehurd/gitshorts
Shell scripts for super quick Git info.
https://github.com/montehurd/gitshorts
git shell-script
Last synced: 4 months ago
JSON representation
Shell scripts for super quick Git info.
- Host: GitHub
- URL: https://github.com/montehurd/gitshorts
- Owner: montehurd
- License: mit
- Created: 2014-11-21T02:22:48.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2025-01-31T22:52:04.000Z (over 1 year ago)
- Last Synced: 2025-01-31T23:26:53.550Z (over 1 year ago)
- Topics: git, shell-script
- Language: Shell
- Homepage:
- Size: 1.28 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# gitshorts
## Motivation
When using Git on the command line, I found myself continually wanting to see:
- **branches** I had locally and which was checked out
- **logs** of recent commits with short commit messages
- **status** of files in the currently checked out branch
- **diffs** of modified but uncommitted files
- **commits** and their file diffs
## Approach
These scripts make seeing everything mentioned above extremely easy. After installation, simply change to a directory under Git source control, then type `aaa` and press enter. You will see output formatted similar to the following:
The repeating sequence `aaa` was chosen to represent showing "All" the info mentioned [above](#user-content-motivation).
Note in the picture above there are six other three-character codes. Three-character repeating codes are extremely easy to invoke. They represent the individual parts of the output displayed when `aaa` is invoked:
- `bbb`
- **branches**, also indicating which branch is checked out
- `lll`
- **log** of most recent commits with optional numeric argument (defaults to 5 if unspecified)
- `sss`
- **status** of files
- `ddd`
- **diff** for each modified but as-of-yet uncommitted file. once activated use arrow keys to navigate between individual file diffs. use `q` to exit back to `aaa`
- `ccc`
- **commits**, showing diff for each historical commit. once activated use arrow keys to navigate between individual commit diffs. most recent commit diff is shown first. use `q` to exit back to `aaa`
- `ppp`
- **prompt**, clearing other console text
## Installation
If this looks useful, installation is fairly easy:
- run `git clone https://github.com/montehurd/gitshorts.git`
- add `export PATH=$PATH:$HOME/gitshorts` to the bottom of your terminal config file. i.e. `~/.zshrc`, `~/.bashrc` or `~/.profile` etc. this basically routes the three-character commands to their respective scripts
- restart your terminal program or reload your particular terminal's config file: i.e. `source ~/.bashrc`, `source ~/.zshrc` or `source ~/.profile` etc
## Tweaks
Each of the three-character codes simply invokes a shell script file named with that three-character code. These scripts can be easily modified as needed - just edit the respective file.
## Known issues
When using `ccc` or `ddd` to view very long diffs, I don't know how to scroll the terminal *completely* to the top in a platform independent way: https://github.com/montehurd/gitshorts/issues/1