Author: Jane Nguyen

Last updated: 19 December 2025

<aside> ✉️

Feel free to contact jane.nguyen1@monash.edu if you have any suggestions or notice anything that needs to be changed or updated!

</aside>

<aside> ⚠️

All of these notes are specific to connecting git to gadi via SSH ONLY.

</aside>

Anything within < > characters denote where something specific needs to be in its place.

</aside>

Installation of jupyterlab-git

[ ] search up extension in gadi jupyter notebook & install
[ ] once installed, the extension should appear as a button on the left hand side of the browser, with a Git symbol

Notes

Creating & Setting Up a Repository

[ ] go into the folder that you would like to make into a repository (make it the pwd)
[ ] type git init
- this creates a .git folder that stores snapshots of all the files between commits (stores all the records) ⇒ DO NOT TOUCH this file

This should take you to a page like the one pictured below:

[ ] Go to the “Quick set up…” subheading and click the “SSH” button
- This generates the unique SSH url to your repository. It starts with git@github.com:
[ ] Copy the unique SSH url by clicking on the “copy” button (it looks like two stacked squares)

[ ] type git remote add origin <unique SSH url you copied>
[ ] type git branch -M main
[ ] type touch .gitignore
- creates a git ignore file to store the names of any folders or files you don’t want on the repository
- more information on how to use .gitignore : https://www.w3schools.com/git/git_ignore.asp
[ ] type git add .gitignore
[ ] type git commit -m "create .gitignore file"
- feel free to change what is inside the “” to a different message if you would like
- this adds a “commit” to your otherwise empty “branch” which will allow the git push to work
[ ] type git push -u origin main

✅ After the above steps are complete, a repository has been successfully created & connected to your chosen directory!

Table of Contents

The below syntax, functions and actions would only appear and work in a repository that has been opened, if you are working from it.

</aside>

Action	🖥️ Terminal syntax	🧩 In Jupyterlab Git Extension	What it does
git add	`git add <specify filename* to add>`	➕ button (appears next to a file in list)	adds this file to the “staging platform”
git commit	`git commit -m "<message>"`	at the bottom where there are summary and description prompts (executed when commit button is clicked)	removes the file from the “staging platform” and creates a record with the included message.
git push	`git push`	☁️ ⬆️ button (appears at the top of the extension)
🟠 appears on this button if there are un-pushed commits	sends what is in your local repository TO GitHub
git pull	`git pull`	☁️ ⬇️ button (appears at the top of the extension)	sends what is in GitHub TO your local repository
git status ℹ️	`git status`	basically how the extension displays the categories of files	provides the status of the repository, listing files that have been staged, that are different or new to the repository etc..
git log ℹ️	`git log`		lists the commit messages
(generally not used)
git restore	`git restore`
(may be more syntax!)	“discard changes” button	change disappears

a specific individual file
a wildcard such as *.ipynb which would add all files with that ending
a wildcard such as * **which should(?) add everything in the directory
- this should ONLY be done when starting a new repository

The buttons that can be clicked on in the extension will have their function appear as text if the button is hovered over.

</aside>

“Refresh” button

appears next to the push & pull clouds at the top of the extension
functions like most refresh buttons, but changes may only appear once changes on a file have been saved </aside>

Example from Elio:

</aside>

the placement of the issue syntax doesn’t matter as long as it is in the message

Pairing the issue number with one of the following keywords in you message allows an issue to be auto-resolved: