Git-Cheatsheet.md

back to overview

Git

• Helpful Commands
• Setup
  • Project
  • New
  • Existing
• Removing
• Patching
• Rebase
• Push --force
• Pull (from force push)
• Squash
• Compare
• Graphite
  • Common Commands
  • Common Workflows
    • New work
    • Sync

Helpful Commands

$ git branch -a                     // show all branches and highlight the one you’re on
$ git reset 5d69206                 // the 7 first numbers of the commit you want to reset
$ git remote prune origin           // Clean-up outdated references to remote branches
$ git reset origin/<branch> --hard  // throw out local

Setup

Project

$ git init // adds git

New

$ git add .
$ git commit -m 'initial project version'
$ git remote add origin URL
$ git push -u origin master

Existing

$ git clone URL (directory name, optional)

Removing

$ git rm -f // remove file when it’s already in the index
$ git rm --cached // keep on hard drive but remove from being tracked
$ git rm --cached -r // remove a folder keep on hard drive but remove from being tracked
$ git rm log/\*.log // removes all files that have the .log extension in the log/ directory
$ git rm \*~ // removes all files that end with ~
$ git mv file-from file-to // to rename a file
$ git branch -d branch-name // delete the branch

Patching

$ git diff --cached > patch.patch
$ git apply patch.patch

Rebase

• Rebase feature_branch on trunk_branch creates NEW commits of feature_branch commits, above trunk_branch commits

$ git pull                  // update
$ git cd feature_branch     // branch to rebase
$ git rebase trunk_branch   // rebase feature_branch on trunk_branch, resolve conflicts
$ git push -f               // force push branch

// if trunk_branch has been rebased since branch to feature_branch, rebase just the commits changed in feature_branch and ignore previous trunk_branch commits (which have been duplicated)
$ git rebase --onto trunk_branch ${commit_before_your_first_commit_on_feature_branch} feature_branch

May be useful to check out git-chain

Push --force

see here When pushing, use -f or --force to overwrite origin with your copy of branch. If this may cause issues, try:

$ git push --force-with-lease [--force-if-includes] origin branch

Force push branch, but ONLY if remote/origin/branch has the same tip commit as local/origin/branch. If --force-if-includes, ONLY if remote/origin/branch has the same tip commit as the branch point of local/branch from local/origin/branch

Pull (from force push)

git reset --hard origin/branch

Squash

$ git reset --soft HEAD~X   // reset local back, removing X commits, but leave changes in working directory
$ git commit                // re-commit all changes

or, with rebase:

$ git rebase -i [HEAD~X]|[commit-hash]  // rebase X commits, or commit-hash of commit before rebased
$ [change all pick to squash/s]

Compare

$ git diff b1..b2           // compare changes from b1 to b2
$ git log b1..b2            // compare commits from b1 to b2

Graphite

cheatsheet

Common Commands

gt log short / gt ls // review stack log

// Navigate
gt co [branch] // checkout branch. interactive without branch name
gt up [n] / gt u [n] // move up n branches
gt down [n] / gt d [n] // move down n branches
gt top / gt t // top-most branch
gt bottom / gt b // bottom-most branch
gt co -t // checkout trunk (i.e. main)

gt create -[a][m] [name] // create commit and create commit. If no name specified, generate name from commit message.
// -a adds all files
// -m add commit message inline

gt modify -[a] / gt m -[a] // amend commit
// -a adds all files

gt absorb -[a] // absorb changes into the correct commits downstream
// -a adds all files

gt submit -[u] // push branches from trunk to here, creating/updating PR for each branch.
// -u only update existing PRs
gt submit -s / gt ss // push descendant branches as well

gt get [branch] // checkout an existing branch and restack from trunk to tip
// if no branch provided, uses current branch

gt sync // pull changes for all branches and restack all branches

Common Workflows

New work

gt co [branch] // interactive without branch

...write some code

gt create -am [name] // create commit and branch

gt ss -u // create PR

Sync