Instruqt Labs (beta)
  • Instruqt
  • Getting started
    • Setting up Version Control
    • Install Instruqt CLI
    • Creating your first lab
    • Configuration basics
    • Exploring the lab configuration
    • Adding your first chapter
    • Configuring sandboxes
    • Adding quizzes
    • Adding tasks and gating content
    • Finishing up
  • Documentation
    • Writing Lab Content
      • Project Structure
      • Markdown and Components
    • Integrations
      • Version Control
    • Lab reference
      • Content
        • Lab
        • Page
        • Activities
          • Task
          • Quiz
            • Multiple Choice
            • Single Choice
            • Text Answer
            • Numeric Answer
        • Layout
        • Tabs
          • Terminal
          • Service
          • Editor
          • External Website
          • Note
      • Sandbox
        • Containers
          • Container
          • Sidecar Container
        • Kubernetes
          • Cluster
          • Config
          • Helm
        • Nomad
          • Cluster
          • Job
        • Networking
          • Network
          • Ingress
        • Cloud Accounts
          • AWS
          • Azure
          • Google Cloud
        • Terraform
        • Template
        • Exec
        • Copy
        • Certificates
          • Root
          • Leaf
        • Random
          • Number
          • ID
          • UUID
          • Password
          • Creature
      • Functions
    • Tools
      • Instruqt CLI
    • Glossary
Powered by GitBook
On this page
  • Example usage
  • Install the Instruqt CLI
Edit on GitHub
Export as PDF
  1. Getting started

Install Instruqt CLI

The Instruqt command-line tool can be used to initialize, format and validate your lab.

Example usage

❯ instruqt lab --help
Create and manage labs

Usage:
  instruqt lab [command]

Available Commands:
  format      Format the lab config at the given path
  init        Initialize a new lab from an example
  validate    Validate a local lab

Flags:
  -h, --help   help for lab

Use "instruqt lab [command] --help" for more information about a command.

Install the Instruqt CLI

Using a package manager

  1. Open a terminal

  2. brew install instruqt/tap/instruqt
  3. Confirm the Instruqt CLI was installed correctly:

    instruqt lab --help
  1. Open a PowerShell window

  2. winget install instruqt
  3. Close and re-open the PowerShell window

  4. Confirm the Instruqt CLI was installed correctly:

    instruqt lab --help

Distributions for apt and rpm based systems will be available soon. Until then, please refer to the manual install below.

Manually from the latest release

  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 lab --help
  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 lab --help
  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 lab --help

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.

PreviousSetting up Version ControlNextCreating your first lab

Last updated 11 days ago

The CLI is available on macOS, Windows and Linux, and can be installed using either a (recommended), or from GitHub releases.

Install the CLI using

Install the CLI using :

Instruqt CLI releases are published to GitHub. You can download the latest release for your Operating System from . Refer to the instructions below how to install these for your system.

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

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

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

Homebrew
WinGet
https://github.com/instruqt/cli/releases/latest
video tutorial
video tutorial
video tutorial
package manager
manually