Rustup

Systems in Rust

Author

Prof. Calvin

Announcements

  • Lab Day
    • Set up environment

Homework

  • The first homework, “Hi world”, is ready after this class.
    • It is comically trivial.
    • Mostly makes sure you have everything set up.
  • Due Friday, 1 Sept. at 1440 ET.

Today

  • Set up your operating system, if it is not UNIX-based.
  • Install Rust.
  • Install Git
  • Bonus!
    • Install Vim, Neovim, or Helix.

Systems

Windows

  • Windows usage is not supported in the course.
  • If you are using Windows, you must:
    • Use Windows Subsystem for Linux (Recommended)
    • Use Docker or Podman
    • Use Git Bash or Mingw in some other way (Discouraged)
    • Use Cygwin (Discouraged)

WSL 2

  • Windows Subsystem for Linux
  • Follow this guide
  • Notes:
    • Use WSL 2. It is the default.
    • I recommend using Ubuntu distribution. You will be asked.
    • I prefer Windows Terminal.
      • Windows key -> “Terminal” -> Enter -> wsl

Docker or Podman

  • Both will require WSL 2, but install for you
  • Docker has better Windows support, I believe Podman is seeing more use.
  • Follow this guide.
  • Notes:

Git Bash

  • I have set up guide for Git Bash for another course
  • This seemed like it could work. I won’t be checking.

Cygwin

  • I have no idea how Cygwin works but it’s pretty cool.
  • Basically no longer in use due to WSL 2 and Docker.
  • Follow this guide

Rust

Rustup

  • On your UNIX-based OS:
    • Linux
    • MacOS
    • WSL 2
    • FreeBSD
  • Open the command line and run the following:
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh

Verify

  • To ensure you have a Rust installation, run:
rustc --version
  • At time of slide creation, I saw this version:
rustc 1.87.0 (17067e9ac 2025-05-09)

Git

Git Installation

  • Ensure you have a Git installation:
    • Windows:
      • Launch WSL
      wsl ~
      • Install git within WSL
      sudo apt install git
    • MacOS: 
      xcode-select --install

Verify

  • Verify install via:
git --version
  • I had:
git version 2.34.1

GitHub

Account

  • Ensure you have an account on GitHub.
  • Read More

Repository

  • Create a repository for this class.
  • Requirements
    • Name is 271rs
    • Use this template
    • May be public or private to you and me (cd-public).
    • Must email me a link to your repository from your @willamette.edu email.

Remote

  • We have now created a remote repository on GitHub.
    • Remote as in “not on our computer we are using right now”
    • As in “on a web server somewhere”
  • No we will make a local repository on our own computer.
  • Then connect them!

ssh

  • We know how to deal with a very important topic:
  • Security
  • When moving executable code between websites and our system, we have to be careful that it is:
    • Not tampered with
    • Made by who said made it

Security Concession

  • We will use SSH, the “Secure Shell Protocol”
  • It is supported by git/GitHub and all major operating systems.

Keygen

  • SSH is based around having “keys”
    • Under the hood, these are special numbers with special properties related to primes, basically.
  • We generate a special unique key we can use as a password or signature.
ssh-keygen

Prompts

  • This example uses (1) the default location and (2) no passphrase.
    • This is less secure but easier to manage.
    • Work in a passphrase as soon as you can!
Generating public/private ed25519 key pair.
Enter file in which to save the key (/home/calvin/.ssh/id_ed25519): 
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 
Your identification has been saved in /home/calvin/.ssh/id_ed25519
$ cat ~/.ssh/id_ed25519.pub 
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIE5cnx/tgBp8v/LnuHz28evmnRPrnlz3cvYaAAM4G0ik calvin@calvin-Precision-3490
  • You now have a key! Let’s find a lock.

GitHub

  • The purpose of this exercise is to connect to GitHub!
  • We will mostly use git for that, but we can check if we have a connection easily:
ssh -T git@github.com

Example

  • This is what I see:
The authenticity of host 'github.com (140.82.116.3)' can't be established.
ED25519 key fingerprint is SHA256:+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU.
This key is not known by any other names.
Are you sure you want to continue connecting (yes/no/[fingerprint])?
  • Before saying “yes” or “no” compare versus the “public SSH key fingerprints”
  • By default, the modern keygen uses “Ed25519” so compare those keys, and click “yes” if they match!

Connecting

  • After confirming the key correctness, you will likely see this.
Are you sure you want to continue connecting (yes/no/[fingerprint])? yes
Warning: Permanently added 'github.com' (ED25519) to the list of known hosts.
git@github.com: Permission denied (publickey).

One Way

  • Now we have instructed our computer to trust GitHub.
  • To save our code to GitHub, we must also get GitHub to trust our computer.
  • We generated our key, now we must match it to our lock on GitHub!

GitHub pt 1

  • We follow this guide
  • Return to GitHub and in the top right click your profile.
    • For me, a picture of myself.
  • Scroll down to “Settings” and click.
    • Last in 2nd grouping, for me.

GitHub pt 2

  • Within settings left-side menu click “SSH and GPG keys”
    • Middle of 2nd group (Access) for me.
  • Within the center block click New SSH key in the top right of the block.

Prompt

  • I get a page “Add new SSH Key”.
  • I provide a title (like “For 271rs class” or “Laptop”)
  • Now we’ll get our key from our system to use.
  • Recall we previously generated a key to the default location, like /home/calvin/.ssh/id_ed25519
    • If you don’t remember, just type ssh-keygen and it’ll show you.

Copy/Paste

  • To get the key for GitHub, we can can
    • cat that file in the command line
    • Copy from the command line
    • Paste into the GitHub “Key” field
    • Click Add SSH key

SSH Test

  • After adding the key to the account, I confirm via SSH like so:
ssh -T git@github.com
  • I see the following:
Hi cd-public! You've successfully authenticated, but GitHub does not provide shell access.

Clone

  • With ssh configured on your local device and on the remote service, you can clone your 271rs.
    • This will be a another copy of the same repository you use.
    • It based off of (templated off of) a repository I made under my account.
    • Template \(\neq\) clone.

Clone pt1

  • Navigate to the repository webpage, like github.com/cd-example/271rs
  • Find the <> Code button in the top right.
  • Click it:
    • Select the top “local” tab (for or local repository)
    • Select the SSH option (for our SSH key)
    • Copy the name, like

git@github.com:cd-example/271rs

Clone pt2

  • Within terminal, where you keep files for this class.
    • Probably just do
    cd ~
git clone git@github.com:cd-example/271rs
  • Verify by listing the contents of the 271rs directory via:
ls 271rs
  • You should see a README.md and a LICENSE

Enter the Repository

  • To change the directory within which you are working in the commandline from your home to the repository for this class, do:
cd 271rs
  • Verify the change via
pwd
  • This will give the full address of your class folder, ending in 271rs

Exercise

Today

  • To complete the lab today, add a 01/rustup.md file to your 271rs
  • Send me a link to a 271rs repository I have permission to view.
    • To be clear:
      • I must receive an email with a hyperlink to a GitHub repository.
      • I must have view access to public repository or a repository on which I am added as a collaborator.

Names Matter

  • Your submission will be tested be a script.
    • The file must be named rustup.md
    • It must be in a folder named 01
    • The repository must be named 271rs
    • No other arrangement constitutes a lab submission.
    • The contents of rustup.md are not relevant. <<<<<<< HEAD

Useful commands

  • You may use ls to list files/folders.
  • You make use mkdir 01 to creat the 01 folder.
  • You may use vim 01/rustup.md to edit the rustup.md file in the 01 folder.
    • The 01 folder must exist to do this.

  • Learn more here

    88d5569f117a55a2960939684283dc3f8d56383e

File Editor

  • Let’s make a new file.
  • I recommend using vim, neovim, or helix.
  • Probably already have it on MacOS.
  • On WSL install via
sudo apt install vim

File Editting

  • To create said file, type vim then the name of the file.
  • If you just cloned 271rs, there will be a 271rs folder into which you should create a 01 folder.
    • Stands for week 0, day 1
    vim 01/rustup.md
<<<<<<< HEAD
    ======= >>>>>>> 88d5569f117a55a2960939684283dc3f8d56383e

Using vim

  • There’s more to life that using vim but basically:
    • Press i to enter “insert mode” (so you can type)
    • When you are done typing, press ESC then type :x to save and exit.
    • Read more
  • Just type some notes you have from today.

Check Status

  • You have now added a new file to your repository.
  • I consult status often, yours will likely look like this:
On branch master

No commits yet

Untracked files:
  (use "git add <file>..." to include in what will be committed)
        01/rustup.md

nothing added to commit but untracked files present (use "git add" to track)

Add

  • The first thing we not is that there are “Untracked files”
  • While we made a hello.py and have it in our hello-world directory, it isn’t yet “tracked” by git!
  • By default, git only keeps track of what we tell it to!
  • So, we tell it to track our code!
git add 01/rustup.md

Status

  • I check status again
On branch master

No commits yet

Changes to be committed:
  (use "git rm --cached <file>..." to unstage)
        new file:   01_rustup.md

Commit

  • With git now aware of hello.py, we need to commit or changes for git to save them.
    • Similar to saving files to the file system.
    • There are, of course, ways to automate this.
  • This probably won’t work at first (next slide!) but try:
git commit -a -m "first commit"

“-a -m”

  • Commits require a commit message (like a version name or number) so specify with -m
  • Usually I provide -a to commit “all” files.
  • I usually make some effort to make my life easier with specific commit messages, perhaps listing:
    • What I’m trying to do
    • Why?

Config

  • If you haven’t used git on your system before, you’ll have to tell git who you are.
    • In git there are no anonymous changes - you have to sign every change you make.
  • You’ll be prompted to provide something like this:
git config --global user.email "you@example.com"
git config --global user.name "Your Name"

My name

  • I often include which computer I’m using in my name and also don’t use a real email address.
    • My GitHub account is already attached to an email address, so I use a throwaway for commits.
git config --global user.email "prof_calvin@c89>rs.edu"
git config --global user.name "Calvin for Class"

Looping Back

  • Once you have provided your identity, you can successfuly complete a commit.
git commit -a -m "first commit"
  • This will:
    • Mark current code as a version, named by your commit message.
  • This won’t:
    • Do anything to GitHub.

Push

  • A commit saves changing on your computer.
  • To save on GitHub, push changes to the cloud
git push
  • After a moment and some diagnostic text, you should be able to see your code on GitHub, possibly after refreshing the page!

Diagnostics

  • For example, you might see the following:
Enumerating objects: 27, done.
Counting objects: 100% (27/27), done.
Delta compression using up to 22 threads
Compressing objects: 100% (15/15), done.
Writing objects: 100% (16/16), 98.54 KiB | 2.46 MiB/s, done.
Total 16 (delta 11), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (11/11), completed with 10 local objects.
To github.com:cd-example/271rs.git
   adaa3a7..ba3c794  main -> main

Verify

Everyday Use

Easier After

  • A lot of what we did, we only have to do once:
    • git config
    • ssh-keygen
    • set origin
  • Many are special cases:
    • Only have to make new repositories for… new repositories (likely projects)
    • Only have to git add for new files.

Quick Example

  • Let’s add 02/hi_world.rs
  • We’ll create a new file at the command line.
vim 02/hi_world.rs
  • Add any text
hi_world.rs
Wait I don't know rust yet.

Add, Commit, Push

  • To get the code onto Github, add to the repo:
git add hi_world.rs
  • Commit changes to a version:
git commit -a -m "You say hello, I say goodbye"
  • Push to GitHub
git push
  • And that’s that!

Altogether

  • For a single copy/paste
git add bye.py
git commit -a -m "You say hello, I say goodbye"
git push
  • If it works, you’ll see the change on GitHub!

Again

  • Perhaps we wish to be more correct with a well-formed Rust comment.
bye.py
// TODO: Homework 0
  • We’ll learn Rust latter.

No Add

  • Don’t need an add this time!
git commit -a -m "Rust comment"
git push

Pulling

  • To get remote changes reflected locally, simply use
git pull
  • This will be how assignment feedback is distributed.
  • Just git pull every time you start working, basically.
  • Also good when you are working on multiple devices.

Fin