Install the CLI
This short guide show you how to install and authenticate the CLI. You can create and manage Instruqt tracks using our the web interface, or you can also download and edit track configuration files locally using the CLI.

Step 1: Download and install the CLI

  1. 1.
    Download the latest release
  2. 2.
    Extract the archive
  3. 3.
    Move the binary to a location in your $PATH, for example:
    • /usr/local/bin
    • /usr/bin
  4. 4.
    To test if you can run the CLI, run the instruqt command in your terminal

Step 2: Authenticate the CLI

To start developing tracks with the CLI, authenticate your local install first
  1. 1.
    Run instruqt auth login in your terminal
  2. 2.
    Open the generated URL in your browser
  3. 3.
    Log in using your Instruqt credentials
To keep you logged in, Instruqt stores an access token in your home directory on the path .config/instruqt/credentials and refreshes the token periodically. If you don't use the CLI for some time, you might be asked to login again.

Last modified 26d ago
Copy link