-
-
Notifications
You must be signed in to change notification settings - Fork 5.3k
/
README.md
1085 lines (752 loc) · 41.3 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# GitHub Cheat Sheet [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
A collection of cool hidden and not so hidden features of Git and GitHub. This cheat sheet was inspired by [Zach Holman](https://github.com/holman)'s [Git and GitHub Secrets](http://confreaks.tv/videos/aloharuby2012-git-and-github-secrets) talk at Aloha Ruby Conference 2012 ([slides](https://speakerdeck.com/holman/git-and-github-secrets)) and his [More Git and GitHub Secrets](https://vimeo.com/72955426) talk at WDCNZ 2013 ([slides](https://speakerdeck.com/holman/more-git-and-github-secrets)).
*Shortlink: [`http://git.io/sheet`](http://git.io/sheet)*
*Read this in other languages: [English](README.md), [한국어](README.ko.md), [日本語](README.ja.md), [简体中文](README.zh-cn.md), [正體中文](README.zh-tw.md).*
GitHub Cheat Sheet is sponsored by [Snapshot: create interactive professional-quality product photos using AI](https://www.snapshotapp.io/)
## Table of Contents
- [GitHub](#github)
- [Ignore Whitespace](#ignore-whitespace)
- [Adjust Tab Space](#adjust-tab-space)
- [Commit History by Author](#commit-history-by-author)
- [Cloning a Repository](#cloning-a-repository)
- [Branch](#branch)
- [Compare all Branches to Another Branch](#compare-all-branches-to-another-branch)
- [Comparing Branches](#comparing-branches)
- [Compare Branches across Forked Repositories](#compare-branches-across-forked-repositories)
- [Gists](#gists)
- [Git.io](#gitio)
- [Keyboard Shortcuts](#keyboard-shortcuts)
- [Line Highlighting in Repositories](#line-highlighting-in-repositories)
- [Closing Issues via Commit Messages](#closing-issues-via-commit-messages)
- [Cross-Link Issues](#cross-link-issues)
- [Locking Conversations](#locking-conversations)
- [CI Status on Pull Requests](#ci-status-on-pull-requests)
- [Filters](#filters)
- [Syntax Highlighting in Markdown Files](#syntax-highlighting-in-markdown-files)
- [Emojis](#emojis)
- [Images/GIFs](#imagesgifs)
- [Embedding Images in GitHub Wiki](#embedding-images-in-github-wiki)
- [Quick Quoting](#quick-quoting)
- [Pasting Clipboard Image to Comments](#pasting-clipboard-image-to-comments)
- [Quick Licensing](#quick-licensing)
- [Task Lists](#task-lists)
- [Task Lists in Markdown Documents](#task-lists-in-markdown-documents)
- [Relative Links](#relative-links)
- [Metadata and Plugin Support for GitHub Pages](#metadata-and-plugin-support-for-github-pages)
- [Viewing YAML Metadata in your Documents](#viewing-yaml-metadata-in-your-documents)
- [Rendering Tabular Data](#rendering-tabular-data)
- [Rendering PDF](#rendering-pdf)
- [Revert a Pull Request](#revert-a-pull-request)
- [Diffs](#diffs)
- [Rendered Prose Diffs](#rendered-prose-diffs)
- [Diffable Maps](#diffable-maps)
- [Expanding Context in Diffs](#expanding-context-in-diffs)
- [Diff or Patch of Pull Request](#diff-or-patch-of-pull-request)
- [Rendering and diffing images](#rendering-and-diffing-images)
- [Hub](#hub)
- [Contribution Guidelines](#contribution-guidelines)
- [CONTRIBUTING file](#contributing-file)
- [ISSUE_TEMPLATE file](#issue_template-file)
- [PULL_REQUEST_TEMPLATE file](#pull_request_template-file)
- [Octicons](#octicons)
- [GitHub Student Developer Pack](#github-student-developer-pack)
- [GitHub Resources](#github-resources)
- [GitHub Talks](#github-talks)
- [SSH keys](#ssh-keys)
- [Profile Image](#profile-image)
- [Repository Templates](#repository-templates)
- [Git](#git)
- [Remove All Deleted Files from the Working Tree](#remove-all-deleted-files-from-the-working-tree)
- [Previous Branch](#previous-branch)
- [Stripspace](#stripspace)
- [Checking out Pull Requests](#checking-out-pull-requests)
- [Empty Commits](#empty-commits)
- [Styled Git Status](#styled-git-status)
- [Styled Git Log](#styled-git-log)
- [Git Query](#git-query)
- [Git Grep](#git-grep)
- [Merged Branches](#merged-branches)
- [Fixup and Autosquash](#fixup-and-autosquash)
- [Web Server for Browsing Local Repositories](#web-server-for-browsing-local-repositories)
- [Git Configurations](#git-configurations)
- [Aliases](#aliases)
- [Auto-Correct](#auto-correct)
- [Color](#color)
- [Git Resources](#git-resources)
- [Git Books](#git-books)
- [Git Videos](#git-videos)
- [Git Articles](#git-articles)
## GitHub
### Ignore Whitespace
Adding `?w=1` to any diff URL will remove any changes only in whitespace, enabling you to see only the code that has changed.
![Diff without whitespace](https://camo.githubusercontent.com/797184940defadec00393e6559b835358a863eeb/68747470733a2f2f6769746875622d696d616765732e73332e616d617a6f6e6177732e636f6d2f626c6f672f323031312f736563726574732f776869746573706163652e706e67)
[*Read more about GitHub secrets.*](https://github.com/blog/967-github-secrets)
### Adjust Tab Space
Adding `?ts=4` to a diff or file URL will display tab characters as 4 spaces wide instead of the default 8. The number after `ts` can be adjusted to suit your preference. This does not work on Gists, or raw file views, but a [Chrome extension](https://chrome.google.com/webstore/detail/tab-size-on-github/ofjbgncegkdemndciafljngjbdpfmbkn) can automate this.
Here is a Go source file before adding `?ts=4`:
![Before, tab space example](http://i.imgur.com/GIT1Fr0.png)
...and this is after adding `?ts=4`:
![After, tab space example](http://i.imgur.com/70FL4H9.png)
### Commit History by Author
To view all commits on a repo by author add `?author={user}` to the URL.
```
https://github.com/rails/rails/commits/master?author=dhh
```
![DHH commit history](http://i.imgur.com/S7AE29b.png)
[*Read more about the differences between commits views.*](https://help.github.com/articles/differences-between-commit-views/)
### Cloning a Repository
When cloning a repository the `.git` can be left off the end.
```bash
$ git clone https://github.com/tiimgreen/github-cheat-sheet
```
[*Read more about the Git `clone` command.*](http://git-scm.com/docs/git-clone)
### Branch
#### Compare all Branches to Another Branch
If you go to the repo's [Branches](https://github.com/tiimgreen/github-cheat-sheet/branches) page, next to the Commits button:
```
https://github.com/{user}/{repo}/branches
```
... you would see a list of all branches which are not merged into the main branch.
From here you can access the compare page or delete a branch with a click of a button.
![Compare branches not merged into master in rails/rails repo - https://github.com/rails/rails/branches](http://i.imgur.com/0FEe30z.png)
#### Comparing Branches
To use GitHub to compare branches, change the URL to look like this:
```
https://github.com/{user}/{repo}/compare/{range}
```
where `{range} = master...4-1-stable`
For example:
```
https://github.com/rails/rails/compare/master...4-1-stable
```
![Rails branch compare example](http://i.imgur.com/tIRCOsK.png)
`{range}` can be changed to things like:
```
https://github.com/rails/rails/compare/master@{1.day.ago}...master
https://github.com/rails/rails/compare/master@{2014-10-04}...master
```
*Here, dates are in the format `YYYY-MM-DD`*
![Another compare example](http://i.imgur.com/5dtzESz.png)
Branches can also be compared in `diff` and `patch` views:
```
https://github.com/rails/rails/compare/master...4-1-stable.diff
https://github.com/rails/rails/compare/master...4-1-stable.patch
```
[*Read more about comparing commits across time.*](https://help.github.com/articles/comparing-commits-across-time/)
#### Compare Branches across Forked Repositories
To use GitHub to compare branches across forked repositories, change the URL to look like this:
```
https://github.com/{user}/{repo}/compare/{foreign-user}:{branch}...{own-branch}
```
For example:
```
https://github.com/rails/rails/compare/byroot:master...master
```
![Forked branch compare](http://i.imgur.com/Q1W6qcB.png)
### Gists
[Gists](https://gist.github.com/) are an easy way to work with small bits of code without creating a fully fledged repository.
![Gist](http://i.imgur.com/VkKI1LC.png?1)
Add `.pibb` to the end of any Gist URL ([like this](https://gist.github.com/tiimgreen/10545817.pibb)) in order to get the *HTML-only* version suitable for embedding in any other site.
Gists can be treated as a repository so they can be cloned like any other:
```bash
$ git clone https://gist.github.com/tiimgreen/10545817
```
![Gists](http://i.imgur.com/BcFzabp.png)
This means you also can modify and push updates to Gists:
```bash
$ git commit
$ git push
Username for 'https://gist.github.com':
Password for 'https://tiimgreen@gist.github.com':
```
However, Gists do not support directories. All files need to be added to the repository root.
[*Read more about creating Gists.*](https://help.github.com/articles/creating-gists/)
### Git.io
[Git.io](http://git.io) is a simple URL shortener for GitHub.
![Git.io](http://i.imgur.com/6JUfbcG.png?1)
You can also use it via pure HTTP using Curl:
```bash
$ curl -i http://git.io -F "url=https://github.com/..."
HTTP/1.1 201 Created
Location: http://git.io/abc123
$ curl -i http://git.io/abc123
HTTP/1.1 302 Found
Location: https://github.com/...
```
[*Read more about Git.io.*](https://github.com/blog/985-git-io-github-url-shortener)
### Keyboard Shortcuts
When on a repository page, keyboard shortcuts allow you to navigate easily.
- Pressing `t` will bring up a file explorer.
- Pressing `w` will bring up the branch selector.
- Pressing `s` will focus the search field for the current repository. Pressing ↓ to select the “All GitHub” option changes the field to search all of GitHub.
- Pressing `l` will edit labels on existing Issues.
- Pressing `y` **when looking at a file** (e.g., `https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.md`) will change your URL to one which, in effect, freezes the page you are looking at. If this code changes, you will still be able to see what you saw at that current time.
To see all of the shortcuts for the current page press `?`:
![Keyboard shortcuts](http://i.imgur.com/y5ZfNEm.png)
[Read more about search syntax you can use.](https://help.github.com/articles/search-syntax/)
### Line Highlighting in Repositories
Either adding, e.g., `#L52` to the end of a code file URL or simply clicking the line number will highlight that line number.
It also works with ranges, e.g., `#L53-L60`, to select ranges, hold `shift` and click two lines:
```
https://github.com/rails/rails/blob/master/activemodel/lib/active_model.rb#L53-L60
```
![Line Highlighting](http://i.imgur.com/8AhjrCz.png)
### Closing Issues via Commit Messages
If a particular commit fixes an issue, any of the keywords `fix/fixes/fixed`, `close/closes/closed` or `resolve/resolves/resolved`, followed by the issue number, will close the issue once it is committed to the repository's default branch.
```bash
$ git commit -m "Fix screwup, fixes #12"
```
This closes the issue and references the closing commit.
![Closing Repo](http://i.imgur.com/Uh1gZdx.png)
[*Read more about closing Issues via commit messages.*](https://help.github.com/articles/closing-issues-via-commit-messages/)
### Cross-Link Issues
If you want to link to another issue in the same repository, simply type hash `#` then the issue number, and it will be auto-linked.
To link to an issue in another repository, `{user}/{repo}#ISSUE_NUMBER`, e.g., `tiimgreen/toc#12`.
![Cross-Link Issues](https://camo.githubusercontent.com/447e39ab8d96b553cadc8d31799100190df230a8/68747470733a2f2f6769746875622d696d616765732e73332e616d617a6f6e6177732e636f6d2f626c6f672f323031312f736563726574732f7265666572656e6365732e706e67)
### Locking Conversations
Pull Requests and Issues can now be locked by owners or collaborators of the repo.
![Lock conversation](https://cloud.githubusercontent.com/assets/2723/3221693/bf54dd44-f00d-11e3-8eb6-bb51e825bc2c.png)
This means that users who are not collaborators on the project will no longer be able to comment.
![Comments locked](https://cloud.githubusercontent.com/assets/2723/3221775/d6e513b0-f00e-11e3-9721-2131cb37c906.png)
[*Read more about locking conversations.*](https://github.com/blog/1847-locking-conversations)
### CI Status on Pull Requests
If set up correctly, every time you receive a Pull Request, [Travis CI](https://travis-ci.org/) will build that Pull Request just like it would every time you make a new commit. Read more about how to [get started with Travis CI](http://docs.travis-ci.com/user/getting-started/).
[![Travis CI status](https://cloud.githubusercontent.com/assets/1687642/2700187/3a88838c-c410-11e3-9a46-e65e2a0458cd.png)](https://github.com/octokit/octokit.rb/pull/452)
[*Read more about the commit status API.*](https://github.com/blog/1227-commit-status-api)
### Filters
Both issues and pull requests allow filtering in the user interface.
For the Rails repo: https://github.com/rails/rails/issues, the following filter is built by selecting the label "activerecord":
`is:issue label:activerecord`
But, you can also find all issues that are NOT labeled activerecord:
`is:issue -label:activerecord`
Additionally, this also works for pull requests:
`is:pr -label:activerecord`
Github has tabs for displaying open or closed issues and pull requests but you
can also see merged pull requests. Just put the following in the filter:
`is:merged`
[*Read more about searching issues.*](https://help.github.com/articles/searching-issues/)
Finally, github now allows you to filter by the Status API's status.
Pull requests with only successful statuses:
`status:success`
[*Read more about searching on the Status API.*](https://github.com/blog/2014-filter-pull-requests-by-status)
### Syntax Highlighting in Markdown Files
For example, to syntax highlight Ruby code in your Markdown files write:
```ruby
require 'tabbit'
table = Tabbit.new('Name', 'Email')
table.add_row('Tim Green', 'tiimgreen@gmail.com')
puts table.to_s
```
This will produce:
```ruby
require 'tabbit'
table = Tabbit.new('Name', 'Email')
table.add_row('Tim Green', 'tiimgreen@gmail.com')
puts table.to_s
```
GitHub uses [Linguist](https://github.com/github/linguist) to perform language detection and syntax highlighting. You can find out which keywords are valid by perusing the [languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
[*Read more about GitHub Flavored Markdown.*](https://help.github.com/articles/github-flavored-markdown/)
### Emojis
Emojis can be added to Pull Requests, Issues, commit messages, repository descriptions, etc. using `:name_of_emoji:`.
The full list of supported Emojis on GitHub can be found at [emoji-cheat-sheet.com](http://www.emoji-cheat-sheet.com/) or [scotch-io/All-Github-Emoji-Icons](https://github.com/scotch-io/All-Github-Emoji-Icons).
A handy emoji search engine can be found at [emoji.muan.co](http://emoji.muan.co/).
The top 5 used Emojis on GitHub are:
1. `:shipit:`
2. `:sparkles:`
3. `:-1:`
4. `:+1:`
5. `:clap:`
### Images/GIFs
Images and GIFs can be added to comments, READMEs etc.:
```
![Alt Text](http://www.sheawong.com/wp-content/uploads/2013/08/keephatin.gif)
```
Raw images from the repo can be used by calling them directly.:
```
![Alt Text](https://github.com/{user}/{repo}/raw/master/path/to/image.gif)
```
![Peter don't care](http://www.sheawong.com/wp-content/uploads/2013/08/keephatin.gif)
All images are cached on GitHub, so if your host goes down, the image will remain available.
#### Embedding Images in GitHub Wiki
There are multiple ways of embedding images in Wiki pages. There's the standard Markdown syntax (shown above). But there's also a syntax that allows things like specifying the height or width of the image:
```markdown
[[ http://www.sheawong.com/wp-content/uploads/2013/08/keephatin.gif | height = 100px ]]
```
Which produces:
![Just a screenshot](http://i.imgur.com/J5bMf7S.png)
### Quick Quoting
When on a comment thread and you want to quote something someone previously said, highlight the text and press `r`, this will copy it into your text box in the block-quote format.
![Quick Quote](https://f.cloud.github.com/assets/296432/124483/b0fa6204-6ef0-11e2-83c3-256c37fa7abc.gif)
[*Read more about quick quoting.*](https://github.com/blog/1399-quick-quotes)
### Pasting Clipboard Image to Comments
_(Works on Chrome browsers only)_
After taking a screenshot and adding it to the clipboard (mac: `cmd-ctrl-shift-4`), you can simply paste (`cmd-v / ctrl-v`) the image into the comment section and it will be auto-uploaded to github.
![Pasting Clipboard Image to Comments](https://cloud.githubusercontent.com/assets/39191/5794265/39c9b65a-9f1b-11e4-9bc7-04e41f59ea5f.png)
[*Read more about issue attachments.*](https://help.github.com/articles/issue-attachments/)
### Quick Licensing
When creating a repository, GitHub gives you the option of adding in a pre-made license:
![License](http://i.imgur.com/Chqj4Fg.png)
You can also add them to existing repositories by creating a new file through the web interface. When the name `LICENSE` is typed in you will get an option to use a template:
![License](http://i.imgur.com/fTjQict.png)
Also works for `.gitignore`.
[*Read more about open source licensing.*](https://help.github.com/articles/open-source-licensing/)
### Task Lists
In Issues and Pull requests check boxes can be added with the following syntax (notice the space):
```
- [ ] Be awesome
- [ ] Prepare dinner
- [ ] Research recipe
- [ ] Buy ingredients
- [ ] Cook recipe
- [ ] Sleep
```
![Task List](http://i.imgur.com/jJBXhsY.png)
When they are clicked, they will be updated in the pure Markdown:
```
- [x] Be awesome
- [ ] Prepare dinner
- [x] Research recipe
- [x] Buy ingredients
- [ ] Cook recipe
- [ ] Sleep
```
[*Read more about task lists.*](https://help.github.com/articles/writing-on-github/#task-lists)
#### Task Lists in Markdown Documents
In full Markdown documents **read-only** checklists can now be added using the following syntax:
```
- [ ] Mercury
- [x] Venus
- [x] Earth
- [x] Moon
- [x] Mars
- [ ] Deimos
- [ ] Phobos
```
- [ ] Mercury
- [x] Venus
- [x] Earth
- [x] Moon
- [x] Mars
- [ ] Deimos
- [ ] Phobos
[*Read more about task lists in markdown documents.*](https://github.com/blog/1825-task-lists-in-all-markdown-documents)
### Relative Links
Relative links are recommended in your Markdown files when linking to internal content.
```markdown
[Link to a header](#awesome-section)
[Link to a file](docs/readme)
```
Absolute links have to be updated whenever the URL changes (e.g., repository renamed, username changed, project forked). Using relative links makes your documentation easily stand on its own.
[*Read more about relative links.*](https://help.github.com/articles/relative-links-in-readmes/)
### Metadata and Plugin Support for GitHub Pages
Within Jekyll pages and posts, repository information is available within the `site.github` namespace, and can be displayed, for example, using `{{ site.github.project_title }}`.
The Jemoji and jekyll-mentions plugins enable [emoji](#emojis) and [@mentions](https://github.com/blog/821) in your Jekyll posts and pages to work just like you'd expect when interacting with a repository on GitHub.com.
[*Read more about repository metadata and plugin support for GitHub Pages.*](https://github.com/blog/1797-repository-metadata-and-plugin-support-for-github-pages)
### Viewing YAML Metadata in your Documents
Many blogging websites, like [Jekyll](http://jekyllrb.com/) with [GitHub Pages](https://pages.github.com), depend on some YAML-formatted metadata at the beginning of your post. GitHub will render this metadata as a horizontal table, for easier reading
![YAML metadata](https://camo.githubusercontent.com/47245aa16728e242f74a9a324ce0d24c0b916075/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f36343035302f313232383236372f65303439643063362d323761302d313165332d396464382d6131636432323539393334342e706e67)
[*Read more about viewing YAML metadata in your documents.*](https://github.com/blog/1647-viewing-yaml-metadata-in-your-documents)
### Rendering Tabular Data
GitHub supports rendering tabular data in the form of `.csv` (comma-separated) and `.tsv` (tab-separated) files.
![Tabular data](https://camo.githubusercontent.com/1b6dd0157ffb45d9939abf14233a0cb13b3b4dfe/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f3238323735392f3937363436322f33323038336463652d303638642d313165332d393262322d3566323863313061353035392e706e67)
[*Read more about rendering tabular data.*](https://github.com/blog/1601-see-your-csvs)
### Rendering PDF
GitHub supports rendering PDF:
![PDF](https://cloud.githubusercontent.com/assets/1000669/7492902/f8493160-f42e-11e4-8cea-1cb4f02757e7.png)
[*Read more about rendering PDF.*](https://github.com/blog/1974-pdf-viewing)
### Revert a Pull Request
After a pull request is merged, you may find it does not help anything or it was a bad decision to merge the pull request.
You can revert it by clicking the **Revert** button on the right side of a commit in the pull request page to create a pull request with reverted changes to this specific pull request.
![Revert button](https://camo.githubusercontent.com/0d3350caf2bb1cba53123ffeafc00ca702b1b164/68747470733a2f2f6769746875622d696d616765732e73332e616d617a6f6e6177732e636f6d2f68656c702f70756c6c5f72657175657374732f7265766572742d70756c6c2d726571756573742d6c696e6b2e706e67)
[*Read more about reverting pull requests*](https://github.com/blog/1857-introducing-the-revert-button)
### Diffs
#### Rendered Prose Diffs
Commits and pull requests, including rendered documents supported by GitHub (e.g., Markdown), feature *source* and *rendered* views.
![Source / Rendered view](https://github-images.s3.amazonaws.com/help/repository/rendered_prose_diff.png)
Click the "rendered" button to see the changes as they'll appear in the rendered document. Rendered prose view is handy when you're adding, removing, and editing text:
![Rendered Prose Diffs](https://f.cloud.github.com/assets/17715/2003056/3997edb4-862b-11e3-90be-5e9586edecd7.png)
[*Read more about rendered prose diffs.*](https://github.com/blog/1784-rendered-prose-diffs)
#### Diffable Maps
Any time you view a commit or pull request on GitHub that includes geodata, GitHub will render a visual representation of what was changed.
[![Diffable Maps](https://f.cloud.github.com/assets/282759/2090660/63f2e45a-8e97-11e3-9d8b-d4c8078b004e.gif)](https://github.com/benbalter/congressional-districts/commit/2233c76ca5bb059582d796f053775d8859198ec5)
[*Read more about diffable maps.*](https://github.com/blog/1772-diffable-more-customizable-maps)
#### Expanding Context in Diffs
Using the *unfold* button in the gutter of a diff, you can reveal additional lines of context with a click. You can keep clicking *unfold* until you've revealed the whole file, and the feature is available anywhere GitHub renders diffs.
![Expanding Context in Diffs](https://f.cloud.github.com/assets/22635/1610539/863c1f64-5584-11e3-82bf-151b406a272f.gif)
[*Read more about expanding context in diffs.*](https://github.com/blog/1705-expanding-context-in-diffs)
#### Diff or Patch of Pull Request
You can get the diff of a Pull Request by adding a `.diff` or `.patch`
extension to the end of the URL. For example:
```
https://github.com/tiimgreen/github-cheat-sheet/pull/15
https://github.com/tiimgreen/github-cheat-sheet/pull/15.diff
https://github.com/tiimgreen/github-cheat-sheet/pull/15.patch
```
The `.diff` extension would give you this in plain text:
```
diff --git a/README.md b/README.md
index 88fcf69..8614873 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i
- [Merged Branches](#merged-branches)
- [Quick Licensing](#quick-licensing)
- [TODO Lists](#todo-lists)
+- [Relative Links](#relative-links)
- [.gitconfig Recommendations](#gitconfig-recommendations)
- [Aliases](#aliases)
- [Auto-correct](#auto-correct)
@@ -381,6 +382,19 @@ When they are clicked, they will be updated in the pure Markdown:
- [ ] Sleep
(...)
```
#### Rendering and diffing images
GitHub can display several common image formats, including PNG, JPG, GIF, and PSD. In addition, there are several ways to compare differences between versions of those image formats.
[![Diffable PSD](https://cloud.githubusercontent.com/assets/2546/3165594/55f2798a-eb56-11e3-92e7-b79ad791a697.gif)](https://github.com/blog/1845-psd-viewing-diffing)
[*Read more about rendering and diffing images.*](https://help.github.com/articles/rendering-and-diffing-images/)
### Hub
[Hub](https://github.com/github/hub) is a command line Git wrapper that gives you extra features and commands that make working with GitHub easier.
This allows you to do things like:
```bash
$ hub clone tiimgreen/toc
```
[*Check out some more cool commands Hub has to offer.*](https://github.com/github/hub#commands)
### Contribution Guidelines
GitHub supports adding 3 different files which help users contribute to your project.
These files can either be placed in the root of your repository or a `.github` directory under the root.
#### CONTRIBUTING File
Adding a `CONTRIBUTING` or `CONTRIBUTING.md` file to either the root of your repository or a `.github` directory will add a link to your file when a contributor creates an Issue or opens a Pull Request.
![Contributing Guidelines](https://camo.githubusercontent.com/71995d6b0e620a9ef1ded00a04498241c69dd1bf/68747470733a2f2f6769746875622d696d616765732e73332e616d617a6f6e6177732e636f6d2f736b697463682f6973737565732d32303132303931332d3136323533392e6a7067)
[*Read more about contributing guidelines.*](https://github.com/blog/1184-contributing-guidelines)
#### ISSUE_TEMPLATE file
You can define a template for all new issues opened in your project. The content of this file will pre-populate the new issue box when users create new issues. Add an `ISSUE_TEMPLATE` or `ISSUE_TEMPLATE.md` file to either the root of your repository or a `.github` directory.
[*Read more about issue templates.*](https://github.com/blog/2111-issue-and-pull-request-templates)
[Issue template file generator](https://www.talater.com/open-source-templates/)
![GitHub Issue template](https://cloud.githubusercontent.com/assets/25792/13120859/733479fe-d564-11e5-8a1f-a03f95072f7a.png)
#### PULL_REQUEST_TEMPLATE file
You can define a template for all new pull requests opened in your project. The content of this file will pre-populate the text area when users create pull requests. Add a `PULL_REQUEST_TEMPLATE` or `PULL_REQUEST_TEMPLATE.md` file to either the root of your repository or a `.github` directory.
[*Read more about pull request templates.*](https://github.com/blog/2111-issue-and-pull-request-templates)
[Pull request template file generator](https://www.talater.com/open-source-templates/)
### Octicons
GitHubs icons (Octicons) have now been open sourced.
![Octicons](https://og.github.com/octicons/octicons@1200x630.png)
[*Read more about GitHub's Octicons*](https://octicons.github.com)
### GitHub Student Developer Pack
If you are a student you will be eligible for the GitHub Student Developer Pack. This gives you free credit, free trials and early access to software that will help you when developing.
![GitHub Student Developer Pack](http://i.imgur.com/9ru3K43.png)
[*Read more about GitHub's Student Developer Pack*](https://education.github.com/pack)
### GitHub Resources
| Title | Link |
| ----- | ---- |
| GitHub Explore | https://github.com/explore |
| GitHub Blog | https://github.com/blog |
| GitHub Help | https://help.github.com/ |
| GitHub Training | https://training.github.com/ |
| GitHub Developer | https://developer.github.com/ |
| Github Education (Free Micro Account and other stuff for students) | https://education.github.com/ |
| GitHub Best Practices | [Best Practices List](https://www.datree.io/resources/github-best-practices) |
#### GitHub Talks
| Title | Link |
| ----- | ---- |
| How GitHub Uses GitHub to Build GitHub | https://www.youtube.com/watch?v=qyz3jkOBbQY |
| Introduction to Git with Scott Chacon of GitHub | https://www.youtube.com/watch?v=ZDR433b0HJY |
| How GitHub No Longer Works | https://www.youtube.com/watch?v=gXD1ITW7iZI |
| Git and GitHub Secrets | https://www.youtube.com/watch?v=Foz9yvMkvlA |
| More Git and GitHub Secrets | https://www.youtube.com/watch?v=p50xsL-iVgU |
### SSH keys
You can get a list of public ssh keys in plain text format by visiting:
```
https://github.com/{user}.keys
```
e.g. [https://github.com/tiimgreen.keys](https://github.com/tiimgreen.keys)
[*Read more about accessing public ssh keys.*](https://changelog.com/github-exposes-public-ssh-keys-for-its-users/)
### Profile Image
You can get a user's profile image by visiting:
```
https://github.com/{user}.png
```
e.g. [https://github.com/tiimgreen.png](https://github.com/tiimgreen.png)
### Repository Templates
You can enable templating on your repository which allows anyone to copy the directory structure and files, allowing them to instantly use the files (e.g. for a tutorial or if writing boilerplate code). This can be enabled in the settings of your repository.
![Convert](https://i.postimg.cc/hGCrVm9F/Template.gif)
Changing to a template repository will give a new URL endpoint which can be shared and instantly allows users to use your repository as a template. Alternatively, they can go to your repository and click the 'Use as template' button.
![Template](https://i.postimg.cc/L8PKCHx0/New-Template.gif)
[*Read more about using repositories as templates*](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/)
## Git
### Remove All Deleted Files from the Working Tree
When you delete a lot of files using `/bin/rm` you can use the following command to remove them from the working tree and from the index, eliminating the need to remove each one individually:
```bash
$ git rm $(git ls-files -d)
```
For example:
```bash
$ git status
On branch master
Changes not staged for commit:
deleted: a
deleted: c
$ git rm $(git ls-files -d)
rm 'a'
rm 'c'
$ git status
On branch master
Changes to be committed:
deleted: a
deleted: c
```
### Previous Branch
To move to the previous branch in Git:
```bash
$ git checkout -
# Switched to branch 'master'
$ git checkout -
# Switched to branch 'next'
$ git checkout -
# Switched to branch 'master'
```
[*Read more about Git branching.*](http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging)
### Stripspace
Git Stripspace:
- Strips trailing whitespace
- Collapses newlines
- Adds newline to end of file
A file must be passed when calling the command, e.g.:
```bash
$ git stripspace < README.md
```
[*Read more about the Git `stripspace` command.*](http://git-scm.com/docs/git-stripspace)
### Checking out Pull Requests
Pull Requests are special branches on the GitHub repository which can be retrieved locally in several ways:
Retrieve a specific Pull Request and store it temporarily in `FETCH_HEAD` for quickly `diff`-ing or `merge`-ing:
```bash
$ git fetch origin refs/pull/[PR-Number]/head
```
Acquire all Pull Request branches as local remote branches by refspec:
```bash
$ git fetch origin '+refs/pull/*/head:refs/remotes/origin/pr/*'
```
Or setup the remote to fetch Pull Requests automatically by adding these corresponding lines in your repository's `.git/config`:
```
[remote "origin"]
fetch = +refs/heads/*:refs/remotes/origin/*
url = git@github.com:tiimgreen/github-cheat-sheet.git
```
```
[remote "origin"]
fetch = +refs/heads/*:refs/remotes/origin/*
url = git@github.com:tiimgreen/github-cheat-sheet.git
fetch = +refs/pull/*/head:refs/remotes/origin/pr/*
```
For Fork-based Pull Request contributions, it's useful to `checkout` a remote branch representing the Pull Request and create a local branch from it:
```bash
$ git checkout pr/42 pr-42
```
Or should you work on more repositories, you can globally configure fetching pull requests in the global git config instead.
```bash
git config --global --add remote.origin.fetch "+refs/pull/*/head:refs/remotes/origin/pr/*"
```
This way, you can use the following short commands in all your repositories:
```bash
git fetch origin
```
```bash
git checkout pr/42
```
[*Read more about checking out pull requests locally.*](https://help.github.com/articles/checking-out-pull-requests-locally/)
### Empty Commits
Commits can be pushed with no code changes by adding `--allow-empty`:
```bash
$ git commit -m "Big-ass commit" --allow-empty
```
Some use-cases for this (that make sense), include:
- Annotating the start of a new bulk of work or a new feature.
- Documenting when you make changes to the project that aren't code related.
- Communicating with people using your repository.
- The first commit of a repository: `git commit -m "Initial commit" --allow-empty`.
### Styled Git Status
Running:
```bash
$ git status
```
produces:
![git status](http://i.imgur.com/qjPyvXb.png)
By adding `-sb`:
```bash
$ git status -sb
```
this is produced:
![git status -sb](http://i.imgur.com/K0OY3nm.png)
[*Read more about the Git `status` command.*](http://git-scm.com/docs/git-status)
### Styled Git Log
Running:
```bash
$ git log --all --graph --pretty=format:'%Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative
```
produces:
![git log --all --graph --pretty=format:'%Cred%h%Creset -%C(auto)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative](http://i.imgur.com/58eOtkW.png)
Credit to [Palesz](http://stackoverflow.com/users/88355/palesz)
*This can be aliased using the instructions found [here](https://github.com/tiimgreen/github-cheat-sheet#aliases).*
[*Read more about the Git `log` command.*](http://git-scm.com/docs/git-log)
### Git Query
A Git query allows you to search all your previous commit messages and find the most recent one matching the query.
```bash
$ git show :/query
```
where `query` (case-sensitive) is the term you want to search, this then finds the last one and gives details on the lines that were changed.
```bash
$ git show :/typo
```
![git show :/query](http://i.imgur.com/icaGiNt.png)
*Press `q` to quit.*
### Git Grep
Git Grep will return a list of lines matching a pattern.
Running:
```bash
$ git grep aliases
```
will show all the files containing the string *aliases*.
![git grep aliases](http://i.imgur.com/DL2zpQ9.png)
*Press `q` to quit.*
You can also use multiple flags for more advanced search. For example:
* `-e` The next parameter is the pattern (e.g., regex)
* `--and`, `--or` and `--not` Combine multiple patterns.
Use it like this:
```bash
$ git grep -e pattern --and -e anotherpattern
```
[*Read more about the Git `grep` command.*](http://git-scm.com/docs/git-grep)
### Merged Branches
Running:
```bash
$ git branch --merged
```
will give you a list of all branches that have been merged into your current branch.
Conversely:
```bash
$ git branch --no-merged
```
will give you a list of branches that have not been merged into your current branch.
[*Read more about the Git `branch` command.*](http://git-scm.com/docs/git-branch)
### Fixup and Autosquash
If there is something wrong with a previous commit (can be one or more from HEAD), for example `abcde`, run the following command after you've amended the problem:
```bash
$ git commit --fixup=abcde
$ git rebase abcde^ --autosquash -i
```
[*Read more about the Git `commit` command.*](http://git-scm.com/docs/git-commit)
[*Read more about the Git `rebase` command.*](http://git-scm.com/docs/git-rebase)
### Web Server for Browsing Local Repositories
Use the Git `instaweb` command to instantly browse your working repository in `gitweb`. This command is a simple script to set up `gitweb` and a web server for browsing the local repository.
```bash
$ git instaweb
```
opens:
![Git instaweb](http://i.imgur.com/Dxekmqc.png)
[*Read more about the Git `instaweb` command.*](http://git-scm.com/docs/git-instaweb)
### Git Configurations
Your `.gitconfig` file contains all your Git configurations.
#### Aliases
Aliases are helpers that let you define your own git calls. For example you could set `git a` to run `git add --all`.
To add an alias, either navigate to `~/.gitconfig` and fill it out in the following format:
```
[alias]
co = checkout
cm = commit
p = push
# Show verbose output about tags, branches or remotes
tags = tag -l
branches = branch -a
remotes = remote -v
```
...or type in the command-line:
```bash
$ git config --global alias.new_alias git_function
```
For example:
```bash
$ git config --global alias.cm commit
```
For an alias with multiple functions use quotes:
```bash
$ git config --global alias.ac 'add -A . && commit'
```
Some useful aliases include:
| Alias | Command | What to Type |
| --- | --- | --- |
| `git cm` | `git commit` | `git config --global alias.cm commit` |
| `git co` | `git checkout` | `git config --global alias.co checkout` |
| `git ac` | `git add . -A` `git commit` | `git config --global alias.ac '!git add -A && git commit'` |
| `git st` | `git status -sb` | `git config --global alias.st 'status -sb'` |
| `git tags` | `git tag -l` | `git config --global alias.tags 'tag -l'` |
| `git branches` | `git branch -a` | `git config --global alias.branches 'branch -a'` |
| `git cleanup` | `git branch --merged \| grep -v '*' \| xargs git branch -d` | `git config --global alias.cleanup "!git branch --merged \| grep -v '*' \| xargs git branch -d"` |
| `git remotes` | `git remote -v` | `git config --global alias.remotes 'remote -v'` |
| `git lg` | `git log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --` | `git config --global alias.lg "log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --"` |