Instruqt Track Builder Library
The Reference Set

Track-level metadata and UI configuration. Sits at the root of every track directory.

Infrastructure declaration. version: "3" at the top, then resources. Skip config.yml entirely if a sandbox_preset is declared in track.yml.

Available in every lifecycle script (setup / check / solve / cleanup) without configuration. Cloud credentials inject only when a matching resource block exists in config.yml.

Pick by what's pre-installed and how fast it boots. Reach for descriptive references in the table below; look up the exact registry path or project slug in your platform's image catalog.

Six tab types group naturally by what they connect to: internal (your declared infrastructure), content (files or virtual browsers), external (URLs outside your track).

Modifiers placed after the opening fence and language identifier turn static code blocks into interactive UI in assignment.md. Comma-separated; order doesn't matter.

Instruqt extends standard Markdown in assignment.md with interactive elements, variable interpolation, and embedded media. CommonMark-compatible underneath.

Bash scripts on Linux, PowerShell on Windows. The filename encodes the target hostname. Track-level scripts run once per play; per-challenge scripts run around each challenge.

Independent assertions, each with its own remediation message. Turns a failed Check button into actionable feedback rather than a generic "something is wrong."

The agent's variable store is a key-value bridge between scripts and assignment bodies. Scripts set keys; bodies read them via [[ Instruqt-Var ]] interpolation.

VM sizing strings for virtualmachines:. Prefer machine_type: over memory:+cpus: — canonical sizing knob across most workshop-image families and partner-published custom images.

Conventional ports for in-track services. Match these to ports: in config.yml, the port: field in service tabs, and the sandbox-public URL pattern.

Two interpolation syntaxes. [[ Instruqt-Var ]] reads from the agent variable store. ${_SANDBOX_ID} is shell-style, scoped to specific config fields. They overlap a little; the field-coverage table shows where each works.

Helper commands shipped on Instruqt-published images. Available in every lifecycle script. Raw upstream Docker images may not have them — guard accordingly.

Track-level time settings and the conventional timelimit / idle_timeout pairings by track scope. Match conventions; budgets and learner expectations are calibrated around them.

Setup scripts boot before the learner sees anything — the difference between "the host is up" and "the service is ready" is where most boot races live. Pick the right wait pattern for the right kind of dependency.

Don't on the left, fix on the right. Read before push, scan when something behaves strangely.

Standards for any HTML artifact in the publishing system. Cheat sheets and decision trees use the same palette, typography, and print rules — extending to a third HTML format inherits the same constraints.