🔧 Tool Setup Troubleshooting Guide

Use this page if something is not working.
Each section is independent — jump directly to the area you are stuck.

GitHub Commit / Config Recovery

Use these commands if git commit is failing

✅ Expectation
You have a GitHub username + email

git config --list` # shows your GitHub username + email.

❌ If not personalized, run to match your credentials:

git config --global user.name "jm1021"        # change to your GitHub ID
git config --global user.email "jm1021@gmail.com"  # change to your Email

Directory + Clone Recovery

✅ Expectation You can cd into your personal directory, and an ls shows your repo folder (ex: student).

cd ~/jm1021 # change jm1021 to your user directory name

❌ If cd fails, run:

mkdir ~/jm1021
cd ~/jm1021

Check for repo folder

ls # lshould show "student"

❌ If missing, run:

git clone https://github.com/jm1021/student.git # change to personal location of repo

Virtual Environment Recovery

✅ Expectation Your terminal prompt shows (venv) prefix.

Run Vitual Environment

source venv/bin/activate

❌ If it fails

./scripts/venv.sh
source venv/bin/activate

VSCode Launch and Memories

✅ Satisfying the pre-requisites

  • In project directory of your repo pwd
  • Sourcing virtual environment source venv/bin/activate
  • Ensure your terminal prompt shows the active virtual environment (venv).

You are now ready to load VSCode and build a proper memory to open your project.

code .

✅ Verify VSCode launch

  • Terminal and presence of (venv) prompt
  • Open your Jokes IPYNB notebook and select the Python kernel with the venv prefix.

❌ If you fail verification

You may have opened your repo project without activating the proper (venv) environment.

Check the Recent listings. If there are entries that look incorrect or outdated (bad memories), remove them all.

  • Shift-Cmd-P (Mac) or Shift-Ctl-P (Windows, KASM)
  • type: Clear Recently Open – select and confirm
  • close VSCode
  • Repeat VSCode Launch and Memories

Version Checks

✅ Expectation

Run the bash script below

  • Output is expected for each ### Command
  • Version may be slightly different, but ask if you are not sure
  • Java kernels are required for CSA only

❌ If it fails

Best course of action is to run OS specific activate scripts from pages project directory

./scripts/activate_ubuntu.sh # windows ubuntu
./scripts/activate_macos.sh # macos
./scripts/activate.sh # help setup git config options

%%script bash

# Define an array of commands
commands=("python --version" "pip --version" "ruby -v" "bundle -v" "gem -v" "jupyter --version" "jupyter kernelspec list" "git config --global user.name" "git config --global user.email")


for cmd in "${commands[@]}"; do
  echo "### Command: $cmd"
  bash -c "$cmd"
done

### Command: python --version
Python 3.13.7
### Command: pip --version
pip 25.2 from /Users/johnmortensen/jm1021/student/venv/lib/python3.13/site-packages/pip (python 3.13)
### Command: ruby -v
ruby 3.4.5 (2025-07-16 revision 20cda200d3) +PRISM [arm64-darwin24]
### Command: bundle -v
Bundler version 2.6.9
### Command: gem -v
3.6.9
### Command: jupyter --version
Selected Jupyter core packages...
IPython          : 9.5.0
ipykernel        : 6.30.1
ipywidgets       : not installed
jupyter_client   : 8.6.3
jupyter_core     : 5.8.1
jupyter_server   : 2.17.0
jupyterlab       : 4.4.6
nbclient         : 0.10.2
nbconvert        : 7.16.6
nbformat         : 5.10.4
notebook         : 7.4.5
qtconsole        : not installed
traitlets        : 5.14.3
### Command: jupyter kernelspec list
Available kernels:
  java           /Users/johnmortensen/Library/Jupyter/kernels/java
  jbang-ijava    /Users/johnmortensen/Library/Jupyter/kernels/jbang-ijava
  python3        /Users/johnmortensen/jm1021/student/venv/share/jupyter/kernels/python3
### Command: git config --global user.name
jm1021
### Command: git config --global user.email
jmort1021@gmail.com