docs(runbook): show --gui variant in §3 job example

2026-06-08 21:46:38 +02:00
parent b317a8bf4c
commit bfc63906a1
1 changed files with 16 additions and 0 deletions
@@ -191,6 +191,22 @@ ci job \
  --use-git-clone
 ```

+The VM boots headless by default. To watch it in the Workstation GUI while it
+runs, add `--gui` (needs an X display — see [§4.7](#47-open-a-vm-in-the-workstation-gui)):
+
+```bash
+ci job \
+  --job-id manual-$(date +%s) \
+  --template-path /var/lib/ci/templates/LinuxBuild2404/LinuxBuild2404.vmx \
+  --snapshot-name BaseClean-Linux \
+  --repo-url https://gitea.emulab.it/Simone/local-ci-cd-system.git \
+  --branch main \
+  --guest-os linux \
+  --build-command "echo build-ok" \
+  --use-git-clone \
+  --gui
+```
+
 `--job-id`, `--repo-url`, `--branch`, and `--template-path` are required. The
 default `--snapshot-name` is `BaseClean`, so Linux jobs must pass
 `--snapshot-name BaseClean-Linux` explicitly. Other useful flags: