|
1 | | -`gg` |
| 1 | +gg |
2 | 2 | == |
3 | 3 |
|
4 | 4 | the cookbook of git goodies |
5 | 5 |
|
6 | 6 |  |
| 7 | + |
| 8 | + |
7 | 9 |
|
8 | 10 | `gg` helps you *work with `git` more efficiently*, saving you keystrokes for your most prized projects. |
9 | 11 |
|
10 | 12 | Think of `gg` as a wrapper for the `git` commands that you run all the time. |
11 | 13 |
|
12 | 14 | ## Getting Started |
13 | | -Suppose we want to clone the [awesome spark shell script (created by Zach Holman)](https://github.com/holman/spark). |
| 15 | +After the [super painless installation](#installation), suppose we want to clone the [awesome spark shell script (created by Zach Holman)](https://github.com/holman/spark). |
14 | 16 |  |
15 | 17 | Alright, let's switch into that directory. |
16 | | - |
| 18 | + |
17 | 19 | After making a quick change, let's check the status of our clone. |
18 | | - |
| 20 | + |
19 | 21 | Looks like we haven't staged our changes. |
20 | 22 |
|
21 | 23 | In the standard git workflow, we would have to `git add -A` and then `git commit -m "Updated example in README."`. |
22 | 24 |
|
23 | 25 | With `gg`, we can simply `gg c Updated example in README.` and we're good to go. |
24 | | - |
| 26 | + |
25 | 27 | Let's check our clone's status again. |
26 | | - |
| 28 | + |
27 | 29 | Looking good! |
| 30 | + |
| 31 | +## Installation |
| 32 | +`gg` can be installed via the Node Package Manager (`npm`). |
| 33 | + |
| 34 | +```sh |
| 35 | + $ npm install -g gg |
| 36 | +``` |
| 37 | +You can also get up and running without npm, but it is not recommended to do so. |
| 38 | + |
| 39 | +`gg` relies on Node.js and `git`. |
| 40 | + |
| 41 | +## Usage |
| 42 | +### Initializing repositories |
| 43 | + |
| 44 | +* `$ gg i` |
| 45 | +* `$ gg init` |
| 46 | +* `$ gg initialize` |
| 47 | + |
| 48 | +### Cloning repositories |
| 49 | + |
| 50 | +* `$ gg cl` |
| 51 | +* `$ gg clone` |
| 52 | + |
| 53 | +### Adding changes |
| 54 | + |
| 55 | +* `$ gg a` |
| 56 | +* `$ gg aa # add all` |
| 57 | +* `$ gg add` |
| 58 | + |
| 59 | +### Committing changes |
| 60 | + |
| 61 | +* `$ gg c` |
| 62 | +* `$ gg commit` |
| 63 | + |
| 64 | +### Pushing commits |
| 65 | + |
| 66 | +* `$ gg p` |
| 67 | +* `$ gg push` |
| 68 | + |
| 69 | +### Pulling commits |
| 70 | + |
| 71 | +* `$ gg pl` |
| 72 | +* `$ gg pull` |
| 73 | + |
| 74 | +### Fetching commits |
| 75 | + |
| 76 | +* `$ gg f` |
| 77 | +* `$ gg fetch` |
| 78 | + |
| 79 | +### Viewing status |
| 80 | + |
| 81 | +* `$ gg s` |
| 82 | +* `$ gg status` |
| 83 | + |
| 84 | +### Viewing log |
| 85 | + |
| 86 | +* `$ gg l` |
| 87 | +* `$ gg log` |
0 commit comments