Instruqt Docs
PlatformGithub
Search
⌃K
Links
Comment on page

Set up Instruqt

What you need to start.
You need the following to start building tracks in Instruqt:
  • An Instruqt account
  • A building tool

Step 1: Create an Instruqt account

  1. 1.
    Go to play.instruqt.com/signup and create an account.
  2. 2.
    Have your colleagues add you to your company's Instruqt organization.
You can also contact [email protected] if you require assistance being added to your company's Instruqt organization.

Step 2: Choose a building tool

You can build tracks with the following tools:
  1. 1.
    Web User Interface (Web UI) A web app that runs in all major browsers.
  2. 2.
    Instruqt Command-Line Interface (Instruqt CLI) A CLI on your local Windows, Mac, or Linux machine.
You are free to choose either tool, and can even use both 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
💻 CLI (Mac)
💻 CLI (Windows)
💻 CLI (Linux)
  1. 1.
    Go to play.instruqt.com​
  2. 2.
    Click Login in the upper right of the Study Room page.
  3. 3.
    Log using your Email and Password, or with a third-party app (Google, GitHub, Twitter). ↳ Once you log in, the Content page opens.
  1. 1.
    Open a terminal.
  2. 2.
    Download the CLI:
    For Apple Silicon Macs
    curl -L https://github.com/instruqt/cli/releases/latest/download/instruqt-darwin-arm64.zip -o instruqt.zip
    For Intel Macs
    curl -L https://github.com/instruqt/cli/releases/latest/download/instruqt-darwin-amd64.zip -o instruqt.zip
  3. 3.
    Extract the CLI binary:
    unzip instruqt.zip
  4. 4.
    Copy the binary to your local bin directory:
    sudo cp instruqt /usr/local/bin
  5. 5.
    Make the binary executable:
    sudo chmod +x /usr/local/bin/instruqt
  6. 6.
    Confirm the Instruqt CLI was installed correctly:
    instruqt
    ↳ The instruqt command should output all of the available commands.
  7. 7.
    Update the CLI to the latest version:
    sudo instruqt update
  8. 8.
    Login in to Instruqt:
    instruqt auth login
    ↳ This opens a browser tab. Login via email, Google, GitHub, or Twitter.
  9. 9.
    CLI collects basic usage statistics that help us develop the product. No personal information is collected. You can disable telemetry with: instruqt config set telemetry false
  10. 10.
    CLI submits crash reports automatically to Instruqt via Sentry, which helps us fix issues you may encounter faster. You can disable this behavior with:
    instruqt config set report-crashes false
Need help? Here's a video tutorial to guide you through the installation process.
  1. 1.
    Open a PowerShell window.
  2. 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. 3.
    Close and re-open your Powershell window to detect the new program.
  4. 4.
    Enter the following command to check if Instruqt CLI was installed correctly:
    instruqt
    ↳ The instruqt command should output all of the available commands.
  5. 5.
    Update the CLI to the latest version:
    instruqt update
  6. 6.
    Login in to Instruqt:
    instruqt auth login
    ↳ This opens a browser tab. Login via email, Google, GitHub, or Twitter.
  7. 7.
    CLI collects basic usage statistics that help us develop the product. No personal information is collected. You can disable telemetry with: instruqt config set telemetry false
  8. 8.
    CLI submits crash reports automatically to Instruqt via Sentry, which helps us fix issues you may encounter faster. You can disable this behavior with:
    instruqt config set report-crashes false
Need help? Here's a video tutorial to guide you through the installation process.
  1. 1.
    Open a terminal.
  2. 2.
    Download the CLI:
    curl -L https://github.com/instruqt/cli/releases/latest/download/instruqt-linux.zip -o instruqt.zip
  3. 3.
    Extract the CLI binary:
    unzip instruqt.zip
  4. 4.
    Copy the binary to your local bin directory:
    sudo cp instruqt /usr/local/bin
  5. 5.
    Make the binary executable:
    sudo chmod +x /usr/local/bin/instruqt
  6. 6.
    Confirm the Instruqt CLI was installed correctly:
    instruqt
    ↳ The instruqt command should output all of the available commands.
  7. 7.
    Update the CLI to the latest version:
    sudo instruqt update
  8. 8.
    Login in to Instruqt:
    instruqt auth login
    ↳ This opens a browser tab. Login via email, Google, GitHub, or Twitter.
  9. 9.
    CLI collects basic usage statistics that help us develop the product. No personal information is collected. You can disable telemetry with: instruqt config set telemetry false
  10. 10.
    CLI submits crash reports automatically to Instruqt via Sentry, which helps us fix issues you may encounter faster. You can disable this behavior with:
    instruqt config set report-crashes false
Need help? Here's a video tutorial to guide you through the installation process.

Step 4: Install a code editor (optional)

If you plan on using the Instruqt CLI, you will 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. 1.
    Download VS Code and follow the installation instructions for your platform.
  2. 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 5mo ago