Run plan

The file

The OMABOOT partition is where OmaBoot? Live keeps its reports. It's made the first time a run saves something: a report, a bug report or the sound setting (M). On a freshly written stick, run it once and save a copy of the report; then the drive is there for the plan.

The smallest plan names one Mac and answers one question. Everything it doesn't answer is asked as usual.

version: 1
macs:
  - match: MacBookAir5,2
    network: ethernet

How a run uses it

1. Hello says a plan was found, which section it uses and what it will do, then counts down 10 seconds. Press any key in that time to ignore the plan for this boot. With start: console it doesn't count down: it waits until you type plan run in the console.
2. Which Mac takes the plan's configuration when several fit. A copy of a run whose Mac didn't come back (a sleep that never woke) is picked up, so its fail stays on record.
3. Network connects the plan's way.
4. Quick pass runs as always. With nobody at the Mac, the graphics notice goes on at once.
5. Hands-on tests open by themselves. A skipped test is recorded without opening; a setup test goes on 3 seconds after its result; a hands-on test waits for you.
6. Finish sends and/or saves the report, then waits, powers off or restarts.

A run is unattended when the Mac's section has no hands-on test. Otherwise it's attended: the plan answers what it can, and the run waits for you at the hands-on tests and at any question the plan couldn't answer.

A plan with a mistake isn't used at all. Hello shows each problem with its line and what to write instead, and the run asks you as usual.

Run plan omaboot-plan.yaml: iMac18,3's section, unattended.
  tests: 2 setup, the rest skipped
  network: ethernet · report saved, then the screen waits
  Starting in 4 s. Press any key to ignore the plan.

Run plan omaboot-plan.yaml found, not used:
  line 6: macs[1] (iMac18,3): tests: power.lid can't be setup
    (only network.ethernet, network.wifi, ports.sd-card,
    storage.optical can); make it hands-on or skip

Top level

A Mac uses the first section whose match is its model identifier (iMac18,3) or its configuration ID (imac18-3-5k-2017-a), ignoring case. A Mac with no section ignores the plan, and Hello says so. One stick can carry a plan for a whole bench of Macs.

A section's keys replace the same keys in defaults. Its tests are merged with the defaults' tests, its own entries winning.

Find a Mac's identifier and configuration ID on DoesItOmarchy.com's Identify page, or on Which Mac.

version: 1
defaults:
  network: ethernet
  results: save
  tests: {default: skip}
macs:
  - match: iMac18,3
    tests: {network.ethernet: setup}
  - match: MacBookAir5,2
    network: offline
    tests: {ports.sd-card: setup}

Test IDs

A Mac runs only the tests that apply to it; a plan may name the others, and they're left out there. The full log (L) shows each result's ID.

Bug reports

A bug report is the run's logs, the report and the screen, saved to the stick's results/ as one file. bugreport takes a list of moments, or none. To send them to OmaBoot? as well, scrubbed (what happens to them), write {when: [moments], send: true}.

The report's notes list the bug reports saved before it.

bugreport: [after-quick, on-problem, at-finish]

bugreport: {when: [on-problem, at-finish], send: true}

bugreport: none

Console and serial port

The console's plan command: plan shows the plan in use, its password masked, and plan check reads the file on the stick again and checks it, with the line and the fix for each problem.

plan run starts the plan from the screen the run is on: a plan with start: console, one ignored at Hello, or one you stopped. It reads the file again first and won't start one with problems. Steps already behind you stay as they are: tests that have a result keep it, and a configuration or network you set by hand stays, noted in the report. plan stop hands the run back to you on the screen it's on. The report's notes say where the plan started and stopped.

For a bench watched over a serial console, the run's last line also goes to the first serial port: what became of the report and the results' tally.

OMABOOT-PLAN: saved results/iMac18,3-20261019T230547Z.json;
need Omarchy installed 2, not tested 15, passed 6

Sample plans

A bench, unattended. Each Mac has a cable in and a card in the slot before power-on. The report goes to DoesItOmarchy.com and the stick, and the Mac powers off.

Attended. The plan answers the screens and skips what you don't have gear for; you sit in for the tests that need hands.

Every key. The whole format in one file, with each value spelled out.

version: 1
defaults:
  network: ethernet
  results: both
  tester: tester-1
  finish: power-off
  bugreport: [on-problem]
  tests:
    default: skip
    network.ethernet: setup
    ports.sd-card: setup
macs:
  - match: iMac18,3
    configuration: imac18-3-5k-2017-a
  - match: iMac18,1
  - match: Macmini4,1
    tests: {storage.optical: setup}

version: 1
macs:
  - match: MacBookAir5,2
    network:
      wifi:
        ssid: Studio
        password: "correct horse battery staple"
    results: save
    tests:
      default: hands-on
      audio.display-out: skip
      graphics.external-display: skip
      ports.firewire: skip

version: 1                  # required
defaults:                   # optional: every Mac, under its own section
  network: ethernet         # ethernet · phone · offline · {wifi: {ssid: …, password: …}}
  results: save             # send · save · both
  tester: tester-1              # letters, digits, . _ - (at most 39)
  finish: wait              # wait · power-off · reboot
  start: auto               # auto (Hello counts down) · console (waits for plan run)
  bugreport: [on-problem]   # after-quick · at-finish · on-problem, or none; {when: […], send: true} sends them
  tests:
    default: hands-on       # hands-on · skip
    network.ethernet: setup # setup: ethernet, sd-card, optical, wifi only
macs:                       # required: at least one section
  - match: iMac18,3         # a model identifier or a configuration ID
    configuration: imac18-3-5k-2017-a
    tests:
      power.sleep-wake: skip