Instruqt Docs
Search…
⌃K
Links

Pull a track

Bring the track files to your machine to take care of everything yourself.
This guide explains how to pull all the track files from the Instruqt platform to your machine to further develop your track from within a code editor.

Pull

Pulling a track takes the following steps:

Step 1: Determine the track slug

🌐 Web UI
  1. 1.
    Open your browser and go to play.instruqt.com. ↳ Instruqt shows your content.
  2. 2.
    Click the track you want to pull to your machine. ↳ Instruqt shows the corresponding Track overview page.
  3. 3.
    Click Edit track details.
  4. 4.
    Note the track slug in the Slug field.

Step 2: Pull the track

💻 Instruqt CLI
  1. 1.
    Open a terminal and move into the directory where you want to have the track files.
  2. 2.
    Enter the following command:
    instruqt track pull TRACK_SLUG
    ⇨ Replace TRACK_SLUG with the track slug that you determined in step 1.
    If you are a member of multiple teams, add the corresponding team of the track you want to pull:
    instruqt track pull TEAM/TRACK_SLUG
    ↳ Instruqt CLI pulls the track files to your machine and places them in a hierarchy of subdirectories. The output will look something like this:
    ==> Finding track by slug: TEAM/TRACK_SLUG
    ==> Updating local track:
    TRACK_SLUG
    ├── 01-welcome-to-instruqt
    │ ├── assignment.md
    │ └── setup-workstation
    ├── 02-installing-the-cli
    │ ├── assignment.md
    │ ├── check-workstation
    │ └── solve-workstation
    ├── 03-instruqt-auth-login
    │ ├── assignment.md
    │ ├── check-workstation
    │ ├── setup-workstation
    │ └── solve-workstation
    ├── track_scripts
    │ └── setup-workstation
    ├── config.yml
    └── track.yml
    OK
You can now further develop your track from within your code editor. And when you are ready, deploy the track by pushing it to the Instruqt platform.