Setting up

How to sign up and install the CLI.

Step 1: Create an account

1. Go to play.instruqt.com/signup and create an account.

2. Have your colleagues add you to your company's Instruqt team.

Step 2: Pick a tool

Start with either the Web UI or install the Instruqt CLI. We recommend starting with the Web UI.

🌐 Web UI

1. Go to play.instruqt.com

2. Click Login in the upper-right corner of the Study Room page.

3. Log using your Email and Password, or using Google, GitHub, Twitter, SSO.

💻 CLI (Mac)

1. Open a terminal.

2. Download the appropriate CLI (Apple Silicon or Intel Macbook, in that order):

   curl -L https://github.com/instruqt/cli/releases/latest/download/instruqt-darwin-arm64.zip -o instruqt.zip

   curl -L https://github.com/instruqt/cli/releases/latest/download/instruqt-darwin-amd64.zip -o instruqt.zip

3. Extract the CLI binary:

   unzip instruqt.zip

4. Copy the binary to your local bin directory:

   sudo cp instruqt /usr/local/bin

5. Make the binary executable:

   sudo chmod +x /usr/local/bin/instruqt

6. Confirm the Instruqt CLI was installed correctly:

   instruqt

Need help? Here's a video tutorial to guide you through the installation process.

💻 CLI (Windows)

1. Open a PowerShell window.

2. Copy and paste the following code:

   mkdir scripts
   cd scripts
   [Environment]::SetEnvironmentVariable("Path", $env:Path + ";$($pwd.Path)", "User")
   Invoke-WebRequest -Uri https://github.com/instruqt/cli/releases/latest/download/instruqt-windows.zip -OutFile "instruqt.zip"
   Expand-Archive instruqt.zip -d .
   rm instruqt.zip

3. Close and re-open your Powershell window to detect the new program.

4. Enter the following command to check if Instruqt CLI was installed correctly:

   instruqt

Need help? Here's a video tutorial to guide you through the installation process.

💻 CLI (Linux)

1. Open a terminal.

2. Download the CLI:

   curl -L https://github.com/instruqt/cli/releases/latest/download/instruqt-linux.zip -o instruqt.zip

3. Extract the CLI binary:

   unzip instruqt.zip

4. Copy the binary to your local bin directory:

   sudo cp instruqt /usr/local/bin

5. Make the binary executable:

   sudo chmod +x /usr/local/bin/instruqt

6. Confirm the Instruqt CLI was installed correctly:

   instruqt

Need help? Here's a video tutorial to guide you through the installation process.

The Instruqt CLI collects basic usage information and sends crash reports by default. No personal information is collected. You can disable these behaviours by following this guide.