Commands

This reference lists the available Instruqt CLI commands and specifies some commonly used commands.
What are commands?
A command is a directive to an operating system or an application to perform a task—for example, copying a file or creating a track in the Instruqt context.
Instruqt CLI commands
You can issue commands to Instruqt CLI if you have installed this application on your machine. 
Instruqt CLI commands always start with the instruqt directive, followed by a command with an optional subcommand and optional flags. For example, challenge is a command which has a create  subcommand and a --title flag:
1
instruqt challenge create --title "Create a Kubernetes cluster"
Copied!
But version is a command on its own:
1
instruqt version
Copied!
Available commands
To explore the available commands, open a terminal on your machine and enter the following command:
1
instruqt --help
Copied!
↳ Instruqt CLI shows the 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.
Drill down commands
You can drill down any command with the --help flag—for example the track command:
1
instruqt track --help
Copied!
↳ After which Instruqt CLI shows the subcommands for track command:
1
Available Commands:
2
  checksum    Get the track checksum
3
  create      Create a new track
4
  delete      Delete a remote track
5
  deploy      Deploy a remote track
6
  logs        Get logs for the track
7
  open        Open the track URL in a browser
8
  pull        Pull the track from the remote server
9
  push        Push the local track to the remote server
10
  test        Test the track with its lifecycle scripts
11
  upgrade     Upgrade track version.
12
  validate    Validate the local track
Copied!
And you can even further drill down by adding a subcommand:
1
instruqt track create --help
Copied!
↳ After which Instruqt CLI shows examples and the flags for the create subcommand:
1
Examples:
2
If you omit the track slug (TRACK), one is generated based on the title:
3
​
4
  $: instruqt track create --title "My first track"
5
​
6
To copy an existing track:
7
​
8
  $: instruqt track create --from instruqt/docker-basics --title "My new track"
9
​
10
Flags:
11
      --from string    The remote track to copy: '<organization-slug>/<track-slug>'
12
  -h, --help           help for create
13
      --title string   The title of the track
Copied!
Commonly used commands
The following commonly used commands are further specified for your reference:
instruqt track create
instruqt challenge create
instruqt track push
instruqt track test
instruqt track logs

Configuration files

Assets

Last modified 28d ago

Copy link

Contents

What are commands?

Instruqt CLI commands

Available commands

Drill down commands

Commonly used commands