Docs / Console commands
Console commands
OmaBoot? Live has a small command console you can open on any screen. Use it to look closer at a result, add a note to the report, save the logs, or measure something again.
Opening it
Press ` (the key left of 1; § on Macs with an ISO keyboard). The console drops down above the hint bar; the screen under it keeps running. Ctrl+` opens it even while a text field has the keyboard.
- Esc
- Closes it.
- Tab
- Takes the dim completion after the cursor. For a command that wants a test, a drive or a step, Tab lists the choices.
- ↑ ↓
- Go back through the commands you've typed.
- ?
- Lists the commands.
- PgUp PgDn
- Scroll the output.
- Ctrl+↑ ↓
- Make the console taller (up to half the screen) or shorter.
Every command you run is written to the run's full log. Only commands that measure again are recorded in the report.
Kinds of command
Each command has a kind, shown as a tag in the list ? prints and on its box below.
- read-only
- Looks only. Never recorded in the report.
- redo
- Measures a test again. The report records it, and the run stays sendable to DoesItOmarchy.com.
- drive-write
- Writes a file to a drive you name, after asking. Changes no result.
Look closer
why <test>
read-onlyThe evidence behind a result: the status, what was measured, the method, the reason for a partial or a fail, and the fix the catalog lists for it. A result you set by hand in a dev build says so.
Tab lists this run's tests.
why network.wifi
log [filter]
read-onlyThe run's full log followed by the kernel log. A filter keeps only the lines that contain it, ignoring case. With no filter the kernel log shows its last 100 lines, since a boot writes a thousand and more. Kernel lines are coloured: the driver in blue, warnings amber, errors red.
Tab lists the 16 commonest drivers in the kernel log.
log brcmfmac
ids
read-onlyThis Mac's hardware IDs, as read from it, with the model's name where the catalog knows it. These are what the run matches against the catalog to find your configuration.
catalog <what>
read-onlyReads the catalog snapshot the run matches against, offline. The snapshot is the one built into the image, or a newer one fetched from DoesItOmarchy.com during this run. With no argument it lists its parts:
catalog source- Where the snapshot came from, its version, its date and how many Macs and configurations it holds.
catalog mac- This Mac as the catalog matched it: model, release, configuration, how it was found and which IDs matched.
catalog search <text>- Macs by identifier or name, up to 12 at a time with a count of the rest.
catalog fixes- The fixes the catalog lists for this configuration, and whether each took effect in this run.
catalog ports- This Mac's ports, by side.
catalog search imac10
plan [check|run|stop]
read-onlyThe run plan this run follows: its section, whether it runs unattended, and each answer it gives, with a Wi-Fi password never shown. When the plan isn't used, it says why. plan check reads omaboot-plan.yaml on the stick again and checks it, with the line and the fix for each problem, so you can correct a plan without restarting. plan run starts the plan from the screen you're on (one with start: console, one ignored at Hello, or one you stopped), and plan stop hands the run back to you. Neither changes a result, so the run stays sendable; the report's notes say where the plan started and stopped.
plan run
smc <key>
read-onlyOne SMC key's type and raw bytes, read through the applesmc driver. The key is four characters. Nothing is ever written to the SMC. For the ambient light keys (ALV0, ALV1) it also shows the reading the driver's light file would give.
Tab offers ALV0, ALV1, ALSL and ALRV.
smc ALV0
report [json]
read-onlyThis run's report so far. On its own it prints one line: how many tests passed, partly passed or failed, how many need Omarchy installed to test, and how many hands-on results there are, plus how many console commands are recorded in it. With json it prints the whole report, exactly as it would be sent.
report json
Add and save
note <text>
read-onlyAdds a note to the report, up to 500 characters each. Notes are public: once DoesItOmarchy.com accepts the report, they show on its page. Don't put a name, an address or a serial number in one.
note lid sensor clicks twice before the screen goes dark
bugreport [send]
read-onlySaves the full log, the kernel log, the report, a text copy of the screen and the boot messages (plus every nap's kernel lines, if you ran sleepcheck) as one archive in the results folder of external storage. The copy on the stick may contain serial numbers, so look before you share it.
bugreport send sends this run's bug reports, and any waiting on the stick, to OmaBoot? to look into. Each is scrubbed of serial numbers, addresses and names first, kept private and deleted after 180 days (what happens to it). The console shows each one's code, such as B-7K2Q-9MXD: quote it when you tell us about the problem. Offline, it waits on the stick for the next online run.
bugreport send
testfile [write <drive>]
drive-writeMakes OmaBoot?'s test file, OMABOOT-TEST.BIN (32 MiB, byte for byte the file from the Download page), on a drive you name, so you don't have to download it on another computer. On its own, testfile lists the drives it can use and why it can't use the others. testfile write <drive> asks first and writes only if you answer y.
- It puts the file in the drive's top folder. Nothing else on the drive changes.
- It works on FAT and exFAT drives and on the OmaBoot? stick's own OMABOOT partition. It never writes to Mac (HFS+) drives, internal disks or the image's own partitions.
- Tab lists the drives it will accept.
testfile
testfile write sdb1
Measure again
rerun <test>
redoMeasures one test again. The new measurement decides the result, and the earlier one goes into its evidence, so why shows both. The report records the command, and the run stays sendable.
Tab lists this run's tests.
rerun network.wifi
sleepcheck [step]
read-onlyTests the kernel's suspend one step at a time, to find where a Mac that hangs going to sleep gets stuck. With no argument it shows what this kernel offers: the sleep modes and states, the pm_test levels, and the console_suspend setting. It records nothing in the report.
all- Runs the levels from the least deep (freezer, devices, platform, processors, core), about 5 seconds each, with no real sleep. Stops at the first that fails.
- a level name
- Runs just that one.
s2idle- A real 15 second light sleep, woken by the clock.
deep- A real 20 second deep sleep, woken by the clock, as in the Sleep and wake test.
nosbp2- After a level,
all,s2idleordeep: takes the FireWire disk driver off for the step and puts it back after. An experiment for Macs that hang with a FireWire disk attached. Without it,sleepcheckrefuses while a FireWire disk is attached.
Each step is written to external storage before it starts, so a hang leaves a trail showing which step began last. A real sleep can hang a Mac that has trouble sleeping, and it then needs a long press of the power button.
sleepcheck all
sleepcheck deep nosbp2
Boot and the session
boot say <text>
read-onlyHas Boot say something in his own box on the screen showing. Up to 60 characters.
boot say hello
clear
read-onlyClears the console's output. The run's full log keeps everything.
close
read-onlyCloses the console, like Esc.
quit restart shutdown
read-onlyOpens the screen's own question, the one Esc asks, with that choice picked, and closes the console. Nothing happens until you confirm. exit is another name for quit.
?
read-onlyLists the commands with their arguments and a tag for each kind, with a legend under the list. help does the same.
Dev builds
Development builds of OmaBoot? Live have a few more commands for the people building it. Release builds leave them out entirely. Among them are commands that set a result by hand. Using one marks the run: the console says so on the frame's top edge, and DoesItOmarchy.com refuses a report from a marked run. A report like that can still be saved to external storage.