\PassOptionsToPackage{unicode}{hyperref}

\PassOptionsToPackage{hyphens}{url}

\PassOptionsToPackage{dvipsnames,svgnames,x11names}{xcolor}

\documentclass[

]{article}

\usepackage{amsmath,amssymb}

\usepackage{iftex}

\usepackage[T1]{fontenc}

\usepackage[utf8]{inputenc}

\usepackage{textcomp} % provide euro and other symbols

\else % if luatex or xetex

\usepackage{unicode-math} % this also loads fontspec

\defaultfontfeatures{Scale=MatchLowercase}

\defaultfontfeatures[\rmfamily]{Ligatures=TeX,Scale=1}

\usepackage{lmodern}

% xetex/luatex font selection

\IfFileExists{upquote.sty}{\usepackage{upquote}}{}

\IfFileExists{microtype.sty}{% use microtype if available

\usepackage[]{microtype}

\UseMicrotypeSet[protrusion]{basicmath} % disable protrusion for tt fonts

}{}

\@ifundefined{KOMAClassName}{% if non-KOMA class

\IfFileExists{parskip.sty}{%

\usepackage{parskip}

}{% else

\setlength{\parindent}{0pt}

\setlength{\parskip}{6pt plus 2pt minus 1pt}}

}{% if KOMA class

\KOMAoptions{parskip=half}}

\usepackage{xcolor}

\usepackage{color}

\usepackage{fancyvrb}

\newcommand{\VerbBar}{|}

\newcommand{\VERB}{\Verb[commandchars=\\\{\}]}

\DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\{\}}

\newenvironment{Shaded}{}{}

\newcommand{\AlertTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}}

\newcommand{\AnnotationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}

\newcommand{\AttributeTok}[1]{\textcolor[rgb]{0.49,0.56,0.16}{#1}}

\newcommand{\BaseNTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}

\newcommand{\BuiltInTok}[1]{\textcolor[rgb]{0.00,0.50,0.00}{#1}}

\newcommand{\CharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}

\newcommand{\CommentTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textit{#1}}}

\newcommand{\CommentVarTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}

\newcommand{\ConstantTok}[1]{\textcolor[rgb]{0.53,0.00,0.00}{#1}}

\newcommand{\ControlFlowTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}}

\newcommand{\DataTypeTok}[1]{\textcolor[rgb]{0.56,0.13,0.00}{#1}}

\newcommand{\DecValTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}

\newcommand{\DocumentationTok}[1]{\textcolor[rgb]{0.73,0.13,0.13}{\textit{#1}}}

\newcommand{\ErrorTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}}

\newcommand{\ExtensionTok}[1]{#1}

\newcommand{\FloatTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}

\newcommand{\FunctionTok}[1]{\textcolor[rgb]{0.02,0.16,0.49}{#1}}

\newcommand{\ImportTok}[1]{\textcolor[rgb]{0.00,0.50,0.00}{\textbf{#1}}}

\newcommand{\InformationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}

\newcommand{\KeywordTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}}

\newcommand{\NormalTok}[1]{#1}

\newcommand{\OperatorTok}[1]{\textcolor[rgb]{0.40,0.40,0.40}{#1}}

\newcommand{\OtherTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{#1}}

\newcommand{\PreprocessorTok}[1]{\textcolor[rgb]{0.74,0.48,0.00}{#1}}

\newcommand{\RegionMarkerTok}[1]{#1}

\newcommand{\SpecialCharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}

\newcommand{\SpecialStringTok}[1]{\textcolor[rgb]{0.73,0.40,0.53}{#1}}

\newcommand{\StringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}

\newcommand{\VariableTok}[1]{\textcolor[rgb]{0.10,0.09,0.49}{#1}}

\newcommand{\VerbatimStringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}

\newcommand{\WarningTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}

\usepackage{graphicx}

\def\maxwidth{\ifdim\Gin@nat@width>\linewidth\linewidth\else\Gin@nat@width\fi}

\def\maxheight{\ifdim\Gin@nat@height>\textheight\textheight\else\Gin@nat@height\fi}

\setkeys{Gin}{width=\maxwidth,height=\maxheight,keepaspectratio}

\def\fps@figure{htbp}

\setlength{\emergencystretch}{3em} % prevent overfull lines

\providecommand{\tightlist}{%

\setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}}

\setcounter{secnumdepth}{-\maxdimen} % remove section numbering

\usepackage{selnolig} % disable illegal ligatures

\usepackage[]{biblatex}

\IfFileExists{bookmark.sty}{\usepackage{bookmark}}{\usepackage{hyperref}}

\IfFileExists{xurl.sty}{\usepackage{xurl}}{} % add URL line breaks if available

\urlstyle{same}

\hypersetup{

pdftitle={Git and Unix Bootcamp},

pdfauthor={Michael Ivanitskiy ([email protected])},

colorlinks=true,

linkcolor={blue},

filecolor={Maroon},

citecolor={Blue},

urlcolor={Blue},

pdfcreator={LaTeX via pandoc}}

\title{Git and Unix Bootcamp}

\author{Michael Ivanitskiy ([email protected])}

\date{}

\begin{document}

\hypertarget{syllabus}{%

\section{``Syllabus''}\label{syllabus}}

\begin{itemize}

polls

introduction

installing git and bash

navigation in bash

common bash utilities

pipes, redirects

absolute basics of vim

basic introduction to git: cloning, staging, commiting, pushing,

pulling

working with multiple people in the same git repository

GitHub-specific tools: pull requests, CI/CD

\end{itemize}

\hypertarget{quick-poll}{%

\section{Quick Poll:}\label{quick-poll}}

\begin{itemize}

which operating system are you currently using? (Mac, Windows, Linux)

have you used a terminal (bash, zsh, fish, cmd, PowerShell) before?

have you used an sh-compatible terminal before?

have you used git or github before?

\end{itemize}

\hypertarget{introduction}{%

\section{Introduction}\label{introduction}}

Some definitions:

\begin{itemize}

an \textbf{Operating System} is software that manages software and

other hardware for a computer, and provides common services.

\begin{itemize}

\tightlist

\item

MacOS, Windows, Android, iOS, and the various Linux distributions

(Ubuntu, Mint, Arch, etc) are all operating systems

\end{itemize}

a \textbf{command-line shell} is a program that interprets a language

that allows the user to have access to operating system services

\begin{itemize}

\tightlist

\item

these services include moving files around, running or stopping

other programs, and pretty much anything you can expect to be able

to do with a computer

\end{itemize}

a \textbf{version control system} is responsible for tracking and

managing changes to source code and programs. when working on all but

the smallest pieces of code, this becomes extremely useful. Think of

it as google docs edit history, but for source code

\begin{itemize}

\tightlist

\item

the only version control system that you should worry about learning

is git -- for now, all others see relatively niche application in

industry

\end{itemize}

\end{itemize}

Now, some history:

\begin{itemize}

``Unix'' is a family of operating systems, originating from Bell Labs

in 1969

the GNU project (a recursive acronym standing for ``GNU's not Unix!'')

was created in 1983 with the goal of giving computer users freedom in

their use of computing devices. it has created a wide variety of

open-source tools, including bash (Bourne-again shell) in 1989 to

replace the original Bourne shell for Unix

``Linux'' is a family of open-source ``unix-like'' operating systems,

and most ``serious'' computing is done on Linux today.

``git'' is a version control system originally created to manage the

development of the Linux kernel, but has been widely adopted in all

areas of software and is the de-facto standard for version control

\end{itemize}

\begin{figure}

\includegraphics{images/unix-evolution.png}

\caption{Evolution of Unix and Unix like systems (credit: Wikipedia)}

\end{figure}

\hypertarget{installing-bash-and-git}{%

\section{Installing bash and git}\label{installing-bash-and-git}}

if you're prompted during installation to select a default text editor

for editing commits, I reccomend \texttt{nano}, but feel free to choose

whatever you're comfortable with

\hypertarget{macos}{%

\subsection{MacOS}\label{macos}}

\begin{itemize}

MacOS comes with either bash or zsh, depending on how recently you've

updated. simply start up the ``Terminal'' program

to install git, go to \href{https://git-scm.com}{git-scm.com}

\end{itemize}

\hypertarget{windows}{%

\subsection{Windows}\label{windows}}

Windows comes with both the \texttt{cmd} shell and PowerShell, but

you'll want to install bash. Navigate to

\href{https://gitforwindows.org}{gitforwindows.org}, and download and

run the installer.

\begin{quote}

NOTE: When prompted about line endings, select ``Check out as-is, commit

\end{quote}

when the installation is complete, start up ``git bash'' from the start

menu

\hypertarget{linux}{%

\subsection{Linux}\label{linux}}

Almost all distributions of Linux come with bash or some other

sh-compatible shell, and git.

\hypertarget{testing}{%

\subsection{testing}\label{testing}}

after installing, launch your terminal, type

\begin{Shaded}

\begin{Highlighting}[]

\FunctionTok{git} \AttributeTok{{-}{-}version}

\end{Highlighting}

\end{Shaded}

and hit enter. It should print the version to the console.

now, type

\begin{Shaded}

\begin{Highlighting}[]

\BuiltInTok{help}

\end{Highlighting}

\end{Shaded}

this should:

\begin{itemize}

tell you what shell you're using

remind you how to use help commands

give the basic keywords of your shell language

\end{itemize}

\hypertarget{bash-basics}{%

\section{Bash Basics}\label{bash-basics}}

firstly, note that:

\begin{itemize}

\href{https://stackoverflow.com}{stackoverflow} is your friend!

adding \texttt{-\/-help} to almost any command will display a help

message explaining how to use it

\texttt{*} is commonly used as a ``wildcard'' -- it will ``match'' any

character or string of characters

text in curly braces \texttt{\{\}} will be used to mean ``replace this

\begin{itemize}

\tightlist

\item

for example, \texttt{cd\ \{path\}} changes your directory, but you

should replace \texttt{\{path\}} with an actual path, such as

\texttt{Downloads}

\item

curly braces \emph{do} have their own special meaning in bash, so be

careful (array construction, parameter expansion, and output

grouping. those are beyond the scope of this tutorial)

\end{itemize}

if you get stuck in what looks like a text editor, its probably either

\texttt{less} or \texttt{vim}. try:

\begin{itemize}

\tightlist

\item

pressing \texttt{q} (this exists \texttt{less})

\item

pressing \texttt{esc}, then \texttt{:}, then \texttt{q} (this exits

vim)\footnote{\href{https://twitter.com/ctrlshifti/status/1282199281982533637}{see

here}}

\end{itemize}

\end{itemize}

\hypertarget{control}{%

\subsection{control}\label{control}}

\begin{itemize}

\texttt{ctrl+C} will close the current process

\texttt{ctrl+Z} will pause the current command, resume it in the

background or foreground with \texttt{fg} or \texttt{bg} respectively

\texttt{TAB} will try to autocomplete a command or file

\(\uparrow\) (up arrow key) will bring up the most recent command

\texttt{ctrl+R} will search among the previous commands (this is

\emph{very} useful)

\texttt{ctrl+A} and \texttt{ctrl+E} will bring the cursor to the start

or end of the line, respectively

\end{itemize}

\hypertarget{navigation-file-management}{%

\subsection{navigation \& file

management}\label{navigation-file-management}}

when you run commands, it is usually important which files are around.

these commands let you move around in and modify the filesystem

\begin{itemize}

\texttt{pwd} will \textbf{p}rint the \textbf{w}orking

\textbf{d}irectory (your current location in the filesystem)

\texttt{ls}: \textbf{l}i\textbf{s}t every file/folder in the current

directory

\begin{itemize}

\tightlist

\item

\texttt{ls\ -al} will print it in a list format with some more data

about the file, notable the filesize in bytes and the date on which

it was last modified

\item

note that \texttt{.} means ``the current directory'' and \texttt{..}

means ``the parent directory''

\end{itemize}

\texttt{cd\ \{path\}} will \textbf{c}hange \textbf{d}irectory to the

specified path

\texttt{mkdir\ \{path\}} will create a directory at the given path

\texttt{rm} will \textbf{r}e\textbf{m}ove a file (be careful!!)

\begin{itemize}

\tightlist

\item

\texttt{rm\ -rf} will remove a directory and its contents

\end{itemize}

\texttt{cp\ \{path1\}\ \{path2\}} and

\texttt{mv\ \{path1\}\ \{path2\}} will \textbf{c}o\textbf{p}y or

\textbf{m}o\textbf{v}e the files specified in \texttt{\{path1\}} to

\texttt{\{path2\}}, respectively.\\

you can do really clever things too, like copy the contents of a

directory:

\begin{itemize}

\tightlist

\item

\texttt{cp\ *.txt\ textfiles/} will copy all files ending in

\texttt{.txt} into the folder \texttt{textfiles}

\item

\texttt{cp\ -R\ data\ moredata} will copy the contents of the folder

\texttt{data}

\end{itemize}

\texttt{find\ -name\ \{name\}} will find all files matching

\texttt{\{name\}}

\end{itemize}

\hypertarget{flow-direction}{%

\subsection{flow direction}\label{flow-direction}}

in the unix philosophy, programs should input and output streams of

text.

\begin{itemize}

a program can read input from \texttt{stdin}, which is equivalent to

prompting the user for some text

a program writes its output to \texttt{stdout}

a program writes any errors or warnings to \texttt{stdin}

\end{itemize}

For modern software, this isn't always the dominant paradigm, but it can

still come in handy. The following commands can be used redirecting the

outputs of a program:

\begin{itemize}

\texttt{\textgreater{}} redirects the \texttt{stdout} of the

preceeding command into the file following the sign. \emph{this will

overwrite any existing file}

\begin{itemize}

\tightlist

\item

note that anything still printed to the console is from

\texttt{stderr}

\end{itemize}

\texttt{2\textgreater{}} redirects \texttt{stderr} to the given file

\begin{itemize}

\tightlist

\item

can be used in combination with \texttt{\textgreater{}}:\\

\texttt{myprogram\ \textgreater{}\ output.txt\ 2\textgreater{}\ errors.txt}

\end{itemize}

\texttt{\textgreater{}\textgreater{}} appends the \texttt{stdout} of

the preceeding command to the specified file, leaving the existing

contents in place

\texttt{\textbar{}} will send \texttt{stdout} of the preceeding

command as \texttt{stdin} to the following command

\end{itemize}

\hypertarget{utilities}{%

\subsection{utilities}\label{utilities}}

bash has many built-in programs, there are many thousands you can

install, and you can even write your own. here are a few I find myself

using regularly.

\begin{itemize}

\texttt{cat\ \{file\}} will print the contents of a text file to the

console. only useful alone for short files

\begin{itemize}

\tightlist

\item

\texttt{cat\ \{file\}\ \textbar{}\ less} will open a simple viewer,

press \texttt{q} to exit

\begin{itemize}

\tightlist

\item

(more on what \texttt{\textbar{}} does later)

\end{itemize}

\item

\texttt{head\ \{file\}\ -n\ \{number\}} or

\texttt{tail\ \{file\}\ -n\ \{number\}} will print

\texttt{\{number\}} lines from the beggining or end of the specified

file, respectively

\end{itemize}

\texttt{diff\ \{file1\}\ \{file2\}} will give the difference between

two text files

\texttt{grep\ \{text\}\ {[}filename{]}} will return lines from

\texttt{{[}filename{]}} with \texttt{\{text\}} in them

\begin{itemize}

\tightlist

\item

this is most useful when searching for something in a file:\\

\texttt{cat\ my\_logfile.txt\ \textbar{}\ grep\ "WARNING"}

\end{itemize}

\texttt{tar} combines multiple files into a ``tarball'', which is a

single file that contains multiple files within it. usage can be

complicated

\begin{itemize}

\tightlist

\item

compressing: \texttt{tar\ -zcvf\ compressed\_files.tar.gz\ folder/}

\item

decompress: \texttt{tar\ -zcvf\ compressed\_files.tar.gz\ folder/}

\end{itemize}

\texttt{gzip} compresses a single file

\texttt{nano\ \{filename\}} opens the \texttt{nano} text editor on a

file

\begin{itemize}

\tightlist

\item

\texttt{nano} helpfully has instructions on the bottom for how to

use it, so you're less likely to get stuck

\item

this is very useful for editing text files when you're connected to

a big supercomputer without a desktop

\end{itemize}

\end{itemize}

\hypertarget{basic-scripting}{%

\subsection{basic scripting}\label{basic-scripting}}

any command you can run in the command line, you can put in a file

\begin{itemize}

printing to console: use \texttt{echo\ "\{stuff\}"}

using variables: all variables in bash are strings. it's a bit weird.

\begin{itemize}

\tightlist

\item

define using \texttt{VARNAME="stuff"}

\item

use later by writing \texttt{\$VARNAME}

\end{itemize}

referencing command line args: in general, \texttt{\$1} is the first

arg, \texttt{\$2} is the second, and so on

control flow:

\begin{itemize}

\tightlist

\item

if-then blocks generally look like

\texttt{bash\ \ \ \ \ \ \ if\ \{command\};\ then\ \ \ \ \ \ \ \ \ \ \ \{code\}\ \ \ \ \ \ \ fi}

but the \texttt{\{command\}} can take many forms.

\texttt{"\$VARNAME"\ ==\ "test"} will evaluate to true, but you can

test for the existence of files and do many other things

\item

for loops: look them up if you must

\end{itemize}

\end{itemize}

a simple example script:

\begin{Shaded}

\begin{Highlighting}[]

\BuiltInTok{echo} \StringTok{"you are located in:"}

\BuiltInTok{pwd}

\VariableTok{dirname}\OperatorTok{=}\VariableTok{$1}