\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{hol} \pdfinfo{ /Title (git-bash-cheat-sheet.pdf) /Creator (Cheatography) /Author (hol) /Subject (Git Bash Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{1D70B8} \definecolor{LightBackground}{HTML}{F0F6FA} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Git Bash Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{hol} via \textcolor{DarkBackground}{\uline{cheatography.com/204235/cs/43643/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}hol \\ \uline{cheatography.com/hol} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Not Yet Published.\\ Updated 23rd July, 2024.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{2} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Key Definitions}} \tn \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{This cheat sheet contains git-specific terms and jargon. Here's a run-down of all the terms you may encounter: \newline % Row Count 3 (+ 3) {\bf{Basic Definitions }} \newline % Row Count 4 (+ 1) {\bf{• Local repo or repository:}} A local directory containing code and files for the project \newline % Row Count 6 (+ 2) {\bf{• Remote repository:}} An online version of the local repository hosted on services like GitHub and GitLab \newline % Row Count 9 (+ 3) {\bf{• Cloning:}} The act of making a clone or copy of a repository in a new director¸ \newline % Row Count 11 (+ 2) {\bf{• Commit:}} A snapshot/save of the project you can come back to \newline % Row Count 13 (+ 2) {\bf{• Branch:}} A copy of the project used for working in an isolated environment without affecting the main project \newline % Row Count 16 (+ 3) {\bf{• Git merge:}} The process of combining two branches together \newline % Row Count 18 (+ 2) {\bf{More advanced definitions}} \newline % Row Count 19 (+ 1) {\bf{`.gitignore` file:}} A file that lists other files you want git not to track (e.g. data folders, outputs, and any local files that shouldn't be seen by the public. \newline % Row Count 23 (+ 4) {\bf{• Staging area:}} a cache that holds changes you want to commit next \newline % Row Count 25 (+ 2) {\bf{• Git stash:}} another type of cache that holds unwanted changes you may want to come back later \newline % Row Count 28 (+ 3) {\bf{• HEAD:}} a reference name for the latest commit. `\{\{lang-bash\}\}HEAD\textbackslash{}\textasciitilde{}n` syntax is used to refer to older commits (e.g. `\{\{lang-bash\}\}HEAD\textasciitilde{}2` refers to the second-to-last commit)% Row Count 32 (+ 4) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{2.16 cm} x{3.6 cm} p{0.72 cm} p{0.72 cm} } \SetRowColor{DarkBackground} \mymulticolumn{4}{x{8.4cm}}{\bf\textcolor{white}{{\bf{Starting a project}}}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}git init {[}project name{]}`}} & Create a new local repository in the current directory names {\bf{{[}project name{]}}}. & & \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} {\bf{`\{\{lang-bash\}\}git clone {[}project ssh url{]}`}} & Downloads a project with the entire history using the {\bf{SSH URL}} from GitLab. & & \tn % Row Count 8 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}----} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{{\bf{Make a Change}}}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}git status`}} & Displays the status of your working directory. Options include new, staged, and modified files. It will retrieve branch name, current commit identifier, and changes pending commit. \tn % Row Count 10 (+ 10) % Row 1 \SetRowColor{white} {\bf{`\{\{lang-bash\}\}git add {[}file{]}`}} & Add a file to the staging area. Use. in place of the full file path to add all changed files from the current directory down into the directory tree. \tn % Row Count 18 (+ 8) % Row 2 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}git add .`}} & Stage all files \tn % Row Count 20 (+ 2) % Row 3 \SetRowColor{white} {\bf{`\{\{lang-bash\}\}git commit -m "commit message"`}} & Create a new commit from changes added to the staging area. The commit must have a message! \tn % Row Count 25 (+ 5) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Branches}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\} git branch`}} & List all local branches. Add `\{\{lang-bash\}\}-r` flag for all remote branches. `\{\{lang-bash\}\}a` flag for all branches. \tn % Row Count 6 (+ 6) % Row 1 \SetRowColor{white} {\bf{`\{\{lang-bash\}\} git branch new-branch`}} & Create a new branch called 'new-branch' \tn % Row Count 9 (+ 3) % Row 2 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\} git check out new-branch`}} & Switch to 'new-branch' branch \& update the working directory \tn % Row Count 12 (+ 3) % Row 3 \SetRowColor{white} {\bf{`\{\{lang-bash\}\} git check out -b new-branch`}} & Create a new branch 'new-branch- and switch to it \tn % Row Count 15 (+ 3) % Row 4 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\} git check out -D new-branch`}} & Delete 'new-branch' \tn % Row Count 18 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Merging}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}git checkout b\{\{nl\}\}git merge a`}} & Merge branch `\{\{lang-bash\}\}a` into branch `\{\{lang-bash\}\}b`. Add `\{\{lang-bash\}\}-{}-no-ff` option for no fast-forward merge \tn % Row Count 6 (+ 6) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Undoing Things}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}git mv {[}existing\_path{]}\{\{nl\}\}{[}new\_path{]}`}} & Move (\&/or rename) a file \& stage move. \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} {\bf{`\{\{lang-bash\}\}git rm {[}file{]}`}} & Remove from staging area only. \tn % Row Count 5 (+ 2) % Row 2 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}git checkout {[}commit\_ID{]}`}} & View a previous commit (READ only) \tn % Row Count 8 (+ 3) % Row 3 \SetRowColor{white} {\bf{`\{\{lang-bash\}\}git revert {[}commit\_ID{]}`}} & Create a new commit, reverting the changes from a specified commit \tn % Row Count 12 (+ 4) % Row 4 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}git reset {[}commit\_ID{]}`}} & Go back to a previous commit \& delete all commits ahead of it (revert is safer). Add `\{\{lang-bash\}\}-{}-hard` flag to also delete workspace changes (BE CAREFUL) \tn % Row Count 20 (+ 8) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.28 cm} x{4.72 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Share \& Update}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}git fetch`}} & Downloads commits and files from a remote repo into your local repo (no merge). \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} {\bf{`\{\{lang-bash\}\}git pull`}} & Downloads content from a remote repo an updates local repo to match content (git fetch + git merge). \tn % Row Count 9 (+ 5) % Row 2 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}git push`}} & Upload local content to remote repo. \tn % Row Count 11 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{.gitignore Patterns}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}*data/`}} & Ignore any directory named {\bf{data}}. \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} {\bf{`\{\{lang-bash\}\}confidential.txt/`}} & Ignore file named {\bf{confidential.txt}}. \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} {\bf{`\{\{lang-bash\}\}*.csv`}} & Ignore any file with the format {\bf{.csv}} \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} {\bf{`\{\{lang-bash\}\}git config\{\{nl\}\}-{}-global core.excludesfile {[}file{]}`}} & System wide ignore pattern for all local repos. \tn % Row Count 10 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{As best practice you should not upload any data or outputs (html, figs) to git. You can find some useful tempates at \{\{link="https://github.com/github/gitignore"\}\}GitHub .gitignore Templates\{\{/link\}\}. \{\{nl\}\}{\bf{NB: You should not hold any sensitive data on GitLab as they may be accessed by others}}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}