riverSpider macOS Setup Script

Full Install Time Estimate: <5 mins

Includes:

• Downloading and installing Homebrew
• Installing necessary packages (coreutils, mise, wget, fd)
• Setting up latest Java OpenJDK
• Downloading and unzipping riverSpiderForMac.zip

Note: Actual time may vary based on your hardware and internet speed. (Tested on M1 Max 10-core, 64GB RAM, 250Mbps connection).

Before Install (Required)

Grant Full Disk Access to Terminal:

1. Go to System Settings > Privacy & Security > Full Disk Access.
2. Click +, navigate to Applications/Utilities/, select Terminal.app, and click Open.
3. Ensure the switch next to Terminal is ON.

Install

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/b1gbyt3/macOS-riverSpider/HEAD/install.sh)"

• Installs: Homebrew, mise, fd, wget, coreutils, OpenJDK
• Adds: easy to use shell function to your config file:
  • riverspider - runs riverSpider/submit.sh on passed file (from anywhere)

    • Usage

      riverspider <your_file.ttpasm>

  • logisim - opens Logisim (from anywhere)

    • Usage

      logisim [your_file.circ]

      Note: [your_file.circ] is optional

  • logproc - opens processor0004.circ in Logisim (from anywhere)
  • logalu - opens alu.circ in Logisim (from anywhere)
  • logreg - opens regbank.circ in Logisim (from anywhere)

After Install (Required)

• Source config:
  • source ~/.zprofile (Zsh)
  • source ~/.bash_profile (Bash)
• Or restart terminal

LIMITATIONS

Shell Config Files

NOTE: CURRENTLY ONLY WORKS ON bash AND zsh

• Defaults:
  • ~/.zprofile (Zsh)
  • ~/.bash_profile (Bash)
• Using different files?

  git clone https://github.com/b1gbyt3/macOS-riverSpider.git && cd macOS-riverSpider

  • Edit in install.sh:

  # --- Shell Settings Filenames ---
  # Default names for the shell configuration files.
  # You might need to change these if you use different filenames like '.zshrc' or '.bashrc'.
  readonly ZSH_PROFILE_BASENAME=".zprofile"      # For Zsh shell
  readonly BASH_PROFILE_BASENAME=".bash_profile" # For Bash shell

  • Run: chmod +x install.sh && ./install.sh

⚠️ No Spaces in Paths!

• ✅ GOOD: ~/CISP_310/riverSpider/
• ❌ BAD: ~/CISP 310/riverSpider/
• ✅ GOOD: ~/CISP310/riverSpider/my-file.ttpasm
• ❌ BAD: ~/CISP_310/riverSpider/my file.ttpasm

NO this ~/"CISP 310"/riverSpider/ and ~/CISP\ 310/riverSpider/ DOESN'T FIX IT