Set up Instruqt

You need the following to start building tracks in Instruqt:
An Instruqt account
A building tool
Step 1: Get your Instruqt account
You can get a free test drive if you do not have an Instruqt account already.
Step 2: Choose your building tool
You can build tracks with the following tools:
Web UI
A web app that runs in all major browsers.
Instruqt CLI
A CLI on your Mac, Linux, or Windows machine.
You are free to choose your building tool. And can even use both tools side by side. Trainers and marketers lean towards the Web UI; developers and sales engineers towards the Instruqt CLI.
Step 3: Set up your chosen tool
Either start the Web UI or install the Instruqt CLI:
🌐 Web UI
💻 Instruqt CLI
1.Open your browser and go to play.instruqt.com​
2.Click Login in the upper right of the Study Room page.
3.Enter your Email and Password in the Login window and click Login.
↳ You are logged in now, and the Content page opens.
The Instruqt CLI is available for Mac, Linux, and Windows. The corresponding installation files are available on GitHub. Pick the installation route for your machine:
Mac
🐧 Linux
Windows
1.Open a terminal.
2.Copy and paste the following code:
curl -L https://github.com/instruqt/cli/releases/download/2036-df08c03/instruqt-darwin-2036-df08c03.zip -o instruqt.zip
unzip instruqt.zip
sudo cp instruqt /usr/local/bin
sudo chmod +x /usr/local/bin/instruqt
3.Enter the following command to check if Instruqt CLI was installed correctly:
instruqt
↳ You installed the Instruqt CLI correctly if you get the following output:
The instruqt SDK command line client is used to create and manage tracks.
​
Usage:
  instruqt [command]
​
Available Commands:
  active-users List all users playing an invite
  auth         Authentication commands.
  challenge    Create and manage challenges.
  completion   Generate shell auto completion scripts.
  config       View and edit Instruqt CLI configuration.
  developer    Manage the developers of a track.
  help         Help about any command
  note         Create and manage notes.
  track        Create and manage tracks
  update       Update the CLI.
  version      Show the version of the CLI.
​
Flags:
  -h, --help   help for instruqt
​
Use "instruqt [command] --help" for more information about a command.
1.Open a terminal.
2.Copy and paste the following code:
curl -L https://github.com/instruqt/cli/releases/download/2036-df08c03/instruqt-linux-2036-df08c03.zip -o instruqt.zip 
unzip instruqt.zip 
sudo cp instruqt /usr/local/bin 
sudo chmod +x /usr/local/bin/instruqt
3.Enter the following command to check if Instruqt CLI was installed correctly:
instruqt
↳ You installed the Instruqt CLI correctly if you get the following output:
The instruqt SDK command line client is used to create and manage tracks.
​
Usage:
  instruqt [command]
​
Available Commands:
  active-users List all users playing an invite
  auth         Authentication commands.
  challenge    Create and manage challenges.
  completion   Generate shell auto completion scripts.
  config       View and edit Instruqt CLI configuration.
  developer    Manage the developers of a track.
  help         Help about any command
  note         Create and manage notes.
  track        Create and manage tracks
  update       Update the CLI.
  version      Show the version of the CLI.
​
Flags:
  -h, --help   help for instruqt
​
Use "instruqt [command] --help" for more information about a command.
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/download/2036-df08c03/instruqt-windows-2036-df08c03.zip -OutFile "instruqt.zip"
Expand-Archive instruqt.zip -d .
rm instruqt.zip
3.Close and re-open your Powershell window.
↳ This step refreshes your environment variables and detects the new program.
4.Enter the following command to check if Instruqt CLI was installed correctly:
instruqt
↳ You installed the Instruqt CLI correctly if you get the following output:
The instruqt SDK command line client is used to create and manage tracks.
​
Usage:
  instruqt [command]
​
Available Commands:
  active-users List all users playing an invite
  auth         Authentication commands.
  challenge    Create and manage challenges.
  completion   Generate shell auto completion scripts.
  config       View and edit Instruqt CLI configuration.
  developer    Manage the developers of a track.
  help         Help about any command
  note         Create and manage notes.
  track        Create and manage tracks
  update       Update the CLI.
  version      Show the version of the CLI.
​
Flags:
  -h, --help   help for instruqt
​
Use "instruqt [command] --help" for more information about a command.
​
Now you can log in to Instruqt with the following steps:
1.Enter this command to login:
instruqt auth login
↳ The output looks like this:
==> Signing in to instruqt
==> Please open the following address in your browser and sign in with your Instruqt credentials:
==> http://localhost:15777/

↳ And your default browser opens and shows four sign-in options:
​
​
2.Click on your sign-in option in the opened browser and enter your credentials.
↳ The browser shows that you successfully logged in:
​
​
3.Close the opened browser and return to your terminal or command prompt.
↳ The terminal shows that your credentials are stored:
==> Storing credentials
​
==> Setting ORGANIZATION_NAME as your default organization.
    Run instruqt config unset organization to undo.
​
==> Run instruqt track create to create your first track.
    OK
⇨ ORGANIZATION_NAME contains your organization.
​
Install a code editor
You also need to install a code editor like Visual Studio Code (VS Code) to edit the Instruqt configuration files. To install VS Code, follow these steps:
1.Download VS Code and follow the installation instructions for your platform.
2.Install the Markdown All In One extension in VS Code.
This extension provides shortcuts and auto-completion for Markdown files.
You are ready now to build tracks.
Getting started - Previous
Design effective tracks
Next - Getting started
Quickstart
Last modified 1mo ago
Copy link
Edit on GitHub
Outline
Step 1: Get your Instruqt account
Step 2: Choose your building tool
Step 3: Set up your chosen tool