Playbooks

A playbook is a named collection of templates that can be started and stopped together with a single command. Use playbooks to spin up an entire training suite or a set of related CVEs at once.

---

List Available Playbooks

vt playbook list

Example output:

+-------------+----------------+--------------+-------------------------------------+
| ID          | NAME           | AUTHOR       | TEMPLATES                           |
+-------------+----------------+--------------+-------------------------------------+
| vt-pb-0001  | Full Lab Suite | hhsteam      | vt-bwapp, vt-dvwa, vt-juice-shop,   |
|             |                |              | vt-mutillidae-ii, vt-webgoat        |
+-------------+----------------+--------------+-------------------------------------+

---

Inspect a Playbook

vt inspect --id vt-pb-0001

Displays the playbook's name, description, author, and the full ordered list of templates it contains.

---

Run a Playbook

Starts every template in the playbook sequentially.

vt playbook run --id <playbook-id>

# With explicit provider
vt playbook run --id <playbook-id> --provider docker-compose

Example:

vt playbook run --id vt-pb-0001

Behavior:

• Templates are started in the order listed in the playbook YAML.
• If one template fails to start, VT logs the error and continues with the remaining templates.
• A summary of successes and failures is printed at the end.

---

Stop a Playbook

Stops every template in the playbook sequentially.

vt playbook stop --id <playbook-id>

# With explicit provider
vt playbook stop --id <playbook-id> --provider docker-compose

Example:

vt playbook stop --id vt-pb-0001

Behavior: Same as run — continues on partial failures and prints a summary.

---

Available Playbooks

ID	Name	Templates Included
vt-pb-0001	Full Lab Suite	vt-bwapp, vt-dvwa, vt-juice-shop, vt-mutillidae-ii, vt-webgoat

---

Playbook File Format

See Template-Structure for the full YAML spec.

Quick reference:

id: vt-pb-0001

info:
  name: "Full Lab Suite"
  description: "Starts all five training labs."
  author: hhsteam

templates:
  - vt-bwapp
  - vt-dvwa
  - vt-juice-shop
  - vt-mutillidae-ii
  - vt-webgoat

Playbook files live in the playbooks/ directory of the vt-templates repository and are synced to your machine with vt template --update.