Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qw3rtman/gg
Git Goodies: At-A-Glance, Efficient, and Aesthetically Pleasing Git Shortcuts
https://github.com/qw3rtman/gg
git
Last synced: 6 days ago
JSON representation
Git Goodies: At-A-Glance, Efficient, and Aesthetically Pleasing Git Shortcuts
- Host: GitHub
- URL: https://github.com/qw3rtman/gg
- Owner: qw3rtman
- License: mit
- Created: 2015-03-02T02:05:34.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T19:40:01.000Z (7 months ago)
- Last Synced: 2024-12-19T05:06:47.992Z (13 days ago)
- Topics: git
- Language: Shell
- Homepage: https://git.io/gitgoodies
- Size: 1.22 MB
- Stars: 1,369
- Watchers: 31
- Forks: 50
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Git Goodies
===========
`gg` helps you *work with `git` more efficiently*, saving you keystrokes for your most prized projects.
Think of `gg` as a wrapper for the `git` commands that you run all the time; a wrapper that adds functionality and is aesthetically pleasing.
### Hold up. Aren't these basically Git aliases?
There's more to the package than just shortcuts or aliases.
For example, the `gg s` command presents you with an easy to look at a quick glance status of your repository. In addition, there are aesthetic changes that increase the intuitiveness of Git itself.
Here's a screenshot of the `gg s` command in action:
You can see the current local branch and its respective remote branch, the latest commit hash and message, the local repository's position in relation with the respective remote repository (alerting you that you should push two commits to reach up-to-date status with the remote repository), the status of staging and commits, and the commits that waiting to be pushed.
**All of this from one four character command.**
## Installation
**Linux/OSX**
```sh
curl -fsSL git.io/gg.sh | bash
```
(HTTPS installation also available via `curl -fsSL https://git.io/gg.sh | bash`)
All this installation script does is download the `gg` script, make it an executable, and copy it to your $PATH (/usr/local/bin). For copying to your $PATH, it may require you to enter your password. If there is a better way to do this, please send in a pull request.
If you don't feel comfortable executing a random script, [its source is available here](https://github.com/qw3rtman/gg/blob/master/install.sh).
**To take advantage of user-specific features (such as `gg cl `), make sure you `git config --global --add gg.username `.**
**If you use [`oh-my-zsh`](https://github.com/robbyrussell/oh-my-zsh), `gg` is already aliased to `git gui citool`. If you don't use this alias, you can unalias it in your `.zshrc` file by adding `unalias gg` at the end of `.zshrc`.**
`gg` relies solely on `git` and attempts to use built-in Shell features over external programs, such as using Bash substitution instead of `sed`.
**Windows:**
Note: This assumes that you already have the `git` installed on your system and
it is configured to be used on the command line.
* Open a Command Prompt window and navigate to a folder included in your PATH.
* Run the following commands
```
powershell -Command "(New-Object Net.WebClient).DownloadFile('https://raw.githubusercontent.com/qw3rtman/gg/master/bin/gg', 'gg')"
powershell -Command "(New-Object Net.WebClient).DownloadFile('https://raw.githubusercontent.com/qw3rtman/gg/master/bin/gg.cmd', 'gg.cmd')"
```
* Open a new Command Prompt window and enjoy.
## Usage
```
usage:
gg [options] [COMMAND] [args]
commands:
gg Display this help information
gg i Initialize new Git repository
gg ig List available .gitignore templates
gg ig Add .gitignore file from
gg igf Add all (s) to .gitignore
gg cl Clone repository from
gg a Add all files
gg a Add all (s)
gg c Add all files and commit with
gg cn Commit with
gg uc Go back (uncommit) commits
gg rc Add all files and recommit (amend) with
gg rcn Recommit (amend) with
gg p Push all commits to remote
gg pl Pull all commits from remote
gg f Fetch all commits from remote
gg s Display repository status
gg l Display repository commit log
gg b List all branches in repository
gg b Create and checkout
gg ch List all branches in repository
gg ch Checkout
gg in Display info about
options:
-V, --version Output current version of Git Goodies
-h, --help Display this help information
```
### Initializing repositories
* `gg i`
* `gg init`
### Adding a template to .gitignore
* `gg ig `
* `gg ignore `
*Templates provided by [.gitignore.io](https://www.gitignore.io/)*
### Adding a file to .gitignore
* `gg igf `
* `gg ignorefile `
### Cloning a repository
* `gg cl `
* `gg clone `
* `gg cl `
* `gg clone `
* `gg cl ` (if you have user-specific features enabled by `git config --global --add gg.username `)
* `gg clone ` (if you have user-specific features enabled by `git config --global --add gg.username `)
*The URL can be provided in any format (SSH, HTTP, etc.)*
### Adding all files
* `gg a`
* `gg add`
### Adding specific files
* `gg a `
* `gg add `
### Adding all and committing
* `gg c `
* `gg commmit `
*If no is provided, a generic one listing all files modified/added will be generated.*
### Committing
* `gg cn `
*If no is provided, a generic one listing all files modified/added will be generated.*
### Uncommiting (resetting: `git reset HEAD~count`)
* `gg uc `
* `gg uncommit `
* `gg back `
*If no is provided, 1 will be used.*
### Adding all and recommitting (amending: `git commit --amend`)
* `gg rc `
* `gg recommit `
* `gg am `
* `gg amend `
*If no is provided, a generic one listing all files modified/added will be generated.*
### Recommitting (amending: `git commit --amend`)
* `gg rcn `
* `gg amn `
*If no is provided, a generic one listing all files modified/added will be generated.*
### Pushing
* `gg p`
* `gg push`
### Pulling
* `gg pl`
* `gg pull`
### Fetching
* `gg f`
* `gg fetch`
### Getting repository status
* `gg s`
* `gg status`
### Displaying commit log
* `gg l`
* `gg log`
### Listing all branches
* `gg b`
* `gg ch`
### Checking out existing branch
* `gg ch `
### Creating and checking out new branch
* `gg b `
### Displaying commit info
* `gg in `
* `gg info `
* `gg view `
*If no is provided, HEAD (last commit) will be used.*
### Displaying **Git Goodies** version
* `gg -V`
* `gg --version`
### Displaying **Git Goodies** help
* `gg`
* `gg -h`
* `gg --help`
* `gg help`
## Contributing
Contributions are always welcome, from a typo in the README to an enhancement of a feature to a completely new feature itself.
Avoid [code smells](http://blog.codinghorror.com/code-smells/), [create reusable code](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself), and follow the loosely-modeled coding standard found in the current code.
Fork the code, make a new branch, and send in a pull request.
See the [TODO](#todo) below for some contributions you can work on!
## TODO
* Integrate with GitHub (Issue [#34](https://github.com/qw3rtman/gg/issues/34))
* Add pretty graphs (Issue [#51](https://github.com/qw3rtman/gg/issues/51))
* Some form of persistent user profile (Issue [#57](https://github.com/qw3rtman/gg/issues/57))
* Shortcut to quickly setup new repository (Issue [#65](https://github.com/qw3rtman/gg/issues/65))