Every wol command, what it does, and which ones helpers may call.
What it is
wol is the one command-line tool for the system: appearance, sound, displays, network, updates, boot, modules, plugins, sessions and more. The desktop, scripts and AI helpers all use the same commands, so what you can do in a terminal you can do from a script.
Why
One tree of commands means one place for help, one place for the approval gate and one place to test. A command that changes the system asks on screen; a read never does.
How
wol <command> --help shows help and never runs the command. --json prints machine-readable output and --yes confirms a prompt. The table below is the complete tree, generated from the program's own command table.
Assistants and automation · Privacy and permissions · Settings · Updates
Reference
173 commands. The last column says what a helper (wol mcp) may do with the command: it reads, changes your own settings, or asks for the administrator password; a dash means helpers cannot call it.
wol theme
| Command | What it does | Helpers |
|---|
wol theme | Current theme id | - |
wol theme current | Current theme id | - |
wol theme list | Installed themes | reads |
wol theme set <id> | Use a theme | changes your settings |
wol theme light | Use the light default theme | - |
wol theme dark | Use the dark default theme | - |
wol theme toggle | Switch light <-> dark | - |
wol theme css [id] | Theme as CSS variables | - |
wol theme get | Current theme, appearance and accent | reads |
wol shell
| Command | What it does | Helpers |
|---|
wol shell toggle <panel> | Toggle a shell panel | - |
wol shell show <panel> | Show a shell panel | - |
wol shell hide <panel> | Hide a shell panel | - |
wol shell reload | Reload the shell | - |
wol update
| Command | What it does | Helpers |
|---|
wol update | List pending package upgrades | - |
wol update check | List pending package upgrades | reads |
wol update status | What the daily check found: package fixes, security fixes, a new release | - |
wol update plan [slot] [release] | Commands an update would run (the other root slot) | - |
wol update apply [slot] [release] | Update into the other root slot (root, --yes) | - |
wol update rollback [slot] | Boot the given (or the previous) restore point next (administrator) | - |
wol update apps | Newer versions of .wol apps; --yes installs them (administrator) | - |
wol encrypt
| Command | What it does | Helpers |
|---|
wol encrypt rebind | First boot: bind the disk key to this computer's firmware state (root) | - |
wol encrypt reseal | After a start the chip refused: bind the disk key to the firmware state again (root) | - |
wol encrypt password [a] | wol-admind: USER's new password (stdin) also opens the disk (root) | - |
wol encrypt decide [a] | Disk encryption for the installer: off, tpm2 or passphrase | - |
wol encrypt enroll [a] [b] [c] [d] | Installer: enroll TPM2 or passphrase and a recovery key (root) | - |
wol encrypt words [a] [b] | Installer: kernel command line words that unlock the disk | - |
wol encrypt hooks [a] | Installer: add the unlock hook to an mkinitcpio config | - |
wol boot
| Command | What it does | Helpers |
|---|
wol boot enroll | Queue this computer's key for the firmware's key screen (root) | - |
wol boot password | Installer: the word typed on the firmware's key screen | - |
wol boot detect [want] | Installer: the protection tier this firmware allows (yes|no: protection wanted) | - |
wol boot key-screen [tier] | Installer: does this tier need the firmware's key screen (yes|no) | - |
wol boot words [tier] | Installer: kernel command line words of a tier | - |
wol boot note [tier] [screen] | Installer: what to tell the person before the restart | - |
wol boot status | Secure Boot, TPM, lockdown and seal state as JSON | - |
wol boot check | Boot check: refuse a kernel older than the slots kept | - |
wol boot bless | After a good boot: raise the rollback floor and name the previous version | - |
wol seal
| Command | What it does | Helpers |
|---|
wol seal apply [root] [digestfile] | Make a system slot read-only and record fs-verity digests (root) | - |
wol seal check | Boot check: the running slot matches what was sealed, else the other slot starts | - |
wol seal off | Developer mode: make the system writable again and stop checking it (root) | - |
wol layers
| Command | What it does | Helpers |
|---|
wol layers fold [a] [b] [c] | Update: copy live-installed packages into the new slot (root) | - |
wol layers clear | Boot: remove the live layers this slot already holds (root) | - |
wol install
| Command | What it does | Helpers |
|---|
wol install info [plan] | Installer: a plan's disk and encryption as shell assignments (root) | - |
wol install probe [disk] | Installer: what is on a disk, as JSON; reads only (root) | - |
wol install check [plan] | Installer: check a plan against the disk as it is now; writes nothing (root) | - |
wol install layout [plan] [key] | Installer: partition and format as the plan says; prints where things went (root) | - |
wol install settings [plan] [root] | Installer: language, keyboard and time zone of the new system (root) | - |
wol install account [plan] [root] [passfile] | Installer: create the account in the new system (root) | - |
wol install facts [disk] | Installer: a disk's facts as lines: size <bytes>, os <family>, bitlocker yes|no; reads only | - |
wol install mounts [disk] | Installer: what of a disk is in use, as lines: mount <path> (deepest first), swap <device> | - |
wol install hostname [name] | Installer: the computer name if valid (settings::hostname), else wolos | - |
wol install <app> | Install a .wol file, an App Store app or a package (administrator) | - |
wol mirror
| Command | What it does | Helpers |
|---|
wol mirror status | Package mirrors, CPU level and whether the [cachyos-*-v3] sections are on | - |
wol mirror rank | Probe the mirrors in parallel, fastest first (--yes writes the order, root) | - |
wol mirror gate | Turn the [cachyos-*-v3] sections on only where the CPU runs x86-64-v3 builds (root, --yes) | - |
wol mirror kernel | System kernel package for this CPU | - |
wol gpu
| Command | What it does | Helpers |
|---|
wol gpu env | Session GPU environment (export lines) | - |
wol gpu hyprconf | compositor render config fragment | - |
wol hw
| Command | What it does | Helpers |
|---|
wol hw | Hardware: every device, its driver and status | reads |
wol hw list | Every device, its driver and status | reads |
wol hw status | Devices that need a driver or firmware, and the fix | reads |
wol hw compute | GPU compute for local AI: backend (cuda, rocm, vulkan or cpu), VRAM and the GPU | reads |
wol hw fix | Load missing drivers (administrator); --yes also installs packages | - |
wol hw boot [--online] | Boot step: load drivers, write tunables (wolos-hw.service, root); --online installs missing packages first | - |
wol modules
| Command | What it does | Helpers |
|---|
wol modules | Optional modules: AI, developer, creative and console stacks, and their state | reads |
wol modules list | Every optional module: installed, enabled, pending or available | reads |
wol modules status [id] | State of one module (or all): installed, enabled, pending, what it needs | reads |
wol modules install <id> | Install a module's packages (administrator); then wol modules enable <id> | - |
wol modules remove <id> | Remove a module's packages (administrator) and its user-side parts | - |
wol modules enable <id> | Finish a module's setup for this user (recipes, mise tools, post step); repeatable | changes your settings |
wol sessions
| Command | What it does | Helpers |
|---|
wol sessions | Terminal and agent windows saved for the next login | reads |
wol sessions list | Terminal and agent windows saved for the next login | reads |
wol sessions save | Save this session's terminal and agent windows (workspace, folder, zellij, claude --continue) | changes your settings |
wol sessions restore | Reopen the saved windows in their workspaces | changes your settings |
wol games
| Command | What it does | Helpers |
|---|
wol games | Games: what Steam and Windows games need, with the fix | - |
wol games doctor | What Steam and Windows games need on this machine, with the fix | - |
wol games steam [url] | Start Steam (downloads it the first time); optional steam:// link | - |
wol power
| Command | What it does | Helpers |
|---|
wol power | Power: source, mode and what the policy sets | - |
wol power status | Power source, mode, battery and what the policy sets | - |
wol power mode <auto|low|high> | auto follows the power source; low saves energy; high is fastest | - |
wol power apply | Apply the power policy now (root; runs by itself when the charger is plugged or unplugged, at boot and after sleep) | - |
wol power sleep | Sleep now | - |
wol power restart | Restart now | - |
wol power shutdown | Shut down now | - |
wol firewall
| Command | What it does | Helpers |
|---|
wol firewall | Firewall: on or off (nothing comes in unasked) | - |
wol firewall status | Firewall on at boot and filtering now | - |
wol firewall on | Turn the firewall on | - |
wol firewall off | Turn the firewall off | - |
wol security
| Command | What it does | Helpers |
|---|
wol security | Firewall, remote login, kernel hardening and the malware check | - |
wol security scan <path> | Check a file, and what is packed inside it, against known malware | - |
wol security allow <path> | Open Anyway: let a file the malware check stopped run on this computer | - |
| Command | What it does | Helpers |
|---|
wol widgets | Widgets on the desktop and the ones you can add | - |
wol widgets list | Widgets on the desktop and the ones you can add | - |
wol widgets add <kind> [size] | Put a widget on the desktop (clock, weather, a package id; small|medium|large) | - |
wol widgets remove <id> | Take a widget off the desktop by its id | - |
wol widgets reload | Reread widgets.json and the widget packages | - |
wol widgets validate <package> | Check a widget package (id or folder): schema, source, every binding | - |
wol plugin
| Command | What it does | Helpers |
|---|
wol plugin | Shell plugins: installed, on or off, problems | reads |
wol plugin list | Shell plugins: installed, on or off, problems | reads |
wol plugin new <id> [kinds] | Scaffold a plugin that passes check (kinds: menubar,widget,panel,search,dock,tile,toggle,hotkey,webapp,theme) | - |
wol plugin check <plugin> | Check a plugin (id or folder): manifest, files, Lua loads and renders, theme, compositor lines | reads |
wol plugin run <plugin> <menubar|widget|panel|search> [entry] [input] | Render one entry headless as JSON (input: a button number to click first, or the search text) | - |
wol plugin enable <id> | Turn a plugin on and grant the permissions it declares | - |
wol plugin disable <id> | Turn a plugin off | - |
wol plugin remove <id> | Delete a user plugin folder and its state | - |
wol plugin add <plugin> | Install a .wolplug file or a plugin folder for this account (unsigned: --yes); turn it on with enable | - |
wol plugin pack <plugin> [out] | Make <id>-<version>.wolplug (zstd tar of the folder with its SHA256 list) next to it or at out | - |
wol appearance
| Command | What it does | Helpers |
|---|
wol appearance | Appearance, accent, theme and wallpaper | reads |
wol appearance set <light|dark|auto> | Light, Dark or Auto (keeps the accent) | changes your settings |
wol wallpaper
| Command | What it does | Helpers |
|---|
wol wallpaper | Current wallpaper | reads |
wol wallpaper set <path> | Use an image file as wallpaper | changes your settings |
wol audio
| Command | What it does | Helpers |
|---|
wol audio | Volume, mute and outputs | reads |
wol audio volume <percent> | Set the volume, 0-100 | changes your settings |
wol audio mute | Mute the sound | changes your settings |
wol audio unmute | Unmute the sound | changes your settings |
wol audio doctor | Sound check: services, inputs above 0 dB, buffers, dropouts, OBS pieces, with the fix | reads |
wol audio reset | Forget stored sound defaults and volumes, drop Pro Audio overrides, restart PipeWire (dry run; --yes does it) | - |
wol audio appmix <on|off|status> | OBS: the "WolOS App Mix" output and "Mic + App Mix" source (pipewire-pulse modules, on demand) | - |
wol display
| Command | What it does | Helpers |
|---|
wol display | Brightness and displays | reads |
wol display brightness <percent> | Set the brightness, 1-100 | changes your settings |
wol wifi
| Command | What it does | Helpers |
|---|
wol wifi | Wi-Fi state and nearby networks | reads |
wol wifi on | Turn Wi-Fi on (administrator) | needs the administrator password |
wol wifi off | Turn Wi-Fi off (administrator) | needs the administrator password |
wol wifi join <ssid> | Join a network; Wi-Fi password on stdin (administrator) | needs the administrator password |
wol bluetooth
| Command | What it does | Helpers |
|---|
wol bluetooth | Bluetooth state | reads |
wol bluetooth on | Turn Bluetooth on (administrator) | needs the administrator password |
wol bluetooth off | Turn Bluetooth off (administrator) | needs the administrator password |
wol focus
| Command | What it does | Helpers |
|---|
wol focus | Do Not Disturb state | reads |
wol focus on | Turn Do Not Disturb on | changes your settings |
wol focus off | Turn Do Not Disturb off | changes your settings |
wol webapp
| Command | What it does | Helpers |
|---|
wol webapp | Your web apps | reads |
wol webapp list | Your web apps | reads |
wol webapp add <name> <url> [icon] | Make a web address an app with its own window and icon | changes your settings |
wol webapp remove <name> | Remove a web app (name or id) | changes your settings |
wol toggle
| Command | What it does | Helpers |
|---|
wol toggle [nightlight|night-light|nightshift|night-shift|stay-awake|idle|awake|caffeine|silence|dnd|focus] [on|off] | Turn a toggle on or off; without on|off it flips; alone it lists them | - |
wol toggle list | Desktop toggles and their state | reads |
wol windows
| Command | What it does | Helpers |
|---|
wol windows | Open windows | reads |
wol windows focus <window> | Bring a window forward (address or app id) | changes your settings |
wol restore
| Command | What it does | Helpers |
|---|
wol restore list | Restore points (the system copies you can start from) | reads |
wol restore activate <slot> | Start from a restore point next boot (administrator) | needs the administrator password |
wol helpers
| Command | What it does | Helpers |
|---|
wol helpers | Helpers: on or off, capabilities, who connected | - |
wol helpers on | Let helpers use WolOS | - |
wol helpers off | Turn every helper away | - |
wol helpers allow <read|appearance|sound|display|network|focus|apps|notify|screen-capture|window-list|files|restore|modules> | Allow helpers one capability | - |
wol helpers deny <read|appearance|sound|display|network|focus|apps|notify|screen-capture|window-list|files|restore|modules> | Deny helpers one capability | - |
wol helpers forget <helper> | Take back every Always Allow of one helper | - |
wol helpers log | What helpers did, newest first | - |
Single commands
| Command | What it does | Helpers |
|---|
wol about | OS, kernel, processor, memory | reads |
wol jobs | Background jobs (wold) | - |
wol start <label> | Start a job (root) | - |
wol stop <label> | Stop a job (root) | - |
wol sys [topic] | System info topic: about stats disks temperatures gpu hw updates | reads |
wol admin <action> [args...] | One allow-listed administrator action (wol-admind; password on stdin) | - |
wol run <bundle> [args...] | Run a .wol bundle (wol-run) | - |
wol port <bundle> | Show which target of a bundle runs on this host | - |
wol base verify | Base files that changed or went missing (wolos-base manifest) | - |
wol pkg [args...] | pacman for the sealed system: wol pkg -- -S name (installs are live at once) | - |
wol api | Every command: arguments, access, approval | - |
wol mcp | Model Context Protocol server on stdin/stdout | - |
wol accent set <violet|blue|pink|red|orange|yellow|green|graphite> | Accent colour (keeps the appearance) | changes your settings |
wol battery | Battery charge and health | reads |
wol network | Online, addresses, Wi-Fi network, Bluetooth | reads |
wol remind <minutes> [text...] | Show a reminder in <minutes> (1..1440) | changes your settings |
wol settings | Your desktop settings | reads |
wol open <target> | Open an app (id or name), a file or an http/https/mailto link | changes your settings |
wol notify <title> [body...] | Show a notification | changes your settings |
wol screenshot | Screenshot of the whole screen; prints the file | changes your settings |
wol files tidy [plan] | Sort Downloads into folders: dry run, then apply its plan id | changes your settings |
wol history | Recent settings changes | reads |
wol undo [id] | Undo the last change, or change <id> | changes your settings |
wol remove <app> | Remove an app installed from a .wol (administrator) | - |
wol list | Apps installed from .wol packages | - |
wol search [term...] | Search the App Store and the .wol index | - |
wol help [command...] | Show help | - |
Reference synced from wonderlandos/wolos crates/controller/src/cli.rs.
