Omarchy CLI Command Reference and Safe Usage

Discover current Omarchy commands through group help and use common update, theme, font, capture, agent, network, and debug operations safely.

The omarchy CLI exposes the menu and internal tooling for terminal work, repeatable configuration, and AI-agent collaboration. Commands expand with releases, so learning how to discover the current interface is more durable than memorizing a static list.

Start with help

omarchy
omarchy commands
omarchy commands --all
omarchy commands --json
omarchy commands --check
omarchy <group> --help
omarchy <group> <command> --help

omarchy prints common commands and groups; commands --all expands internal commands; --json targets scripts; --check validates the command index. Automation must still verify exit codes and idempotency rather than parse colored prose as a stable API.

Common commands

Goal	Current official entry point
Update the system	`omarchy update`
List/apply themes	`omarchy theme list` / `omarchy theme set <name>`
List fonts	`omarchy font list`
Take a screenshot	`omarchy screenshot` / `omarchy capture screenshot --help`
Print debug information	`omarchy debug`
Add/drop a package	`omarchy pkg add <package>` / `omarchy pkg drop <package>`
Create/restore a snapshot	`omarchy-snapshot create` / `omarchy-snapshot restore`
Reinstall shipped defaults	`omarchy reinstall`

Replace placeholders rather than copying angle brackets literally. <name> means a real value listed by current help.

Useful command groups

The current CLI includes groups such as:

agent: launchers, usage, and crash analysis;
audio, bluetooth, brightness, network: hardware control;
bar: shell bar layout and settings;
capture: screenshots, recording, OCR, and QR;
channel: stable, RC, edge, and dev channels;
clipboard: clipboard helpers;
config: system configuration helpers;
debug: diagnostics and support logs;
menu: open or target the graphical menu;
plugin: shell plugins and bar widgets;
theme, font: style;
transcode: image and video conversion.

Discover exact subcommands:

omarchy capture --help
omarchy capture screenshot --help
omarchy network --help
omarchy bar --help
omarchy plugin --help

Capture examples

omarchy capture screenshot region
omarchy capture screenshot fullscreen save
omarchy capture text
omarchy capture qr
omarchy transcode ~/Videos/demo.mov mp4 1080p

Capture and OCR write to disk or clipboard. In automation, specify scope and save behavior so another display or sensitive window is not captured accidentally.

Open the root or a specific menu path:

omarchy menu
omarchy menu summon style.theme
omarchy menu toggle system
omarchy menu close

Bar examples:

omarchy bar position bottom
omarchy bar transparent toggle
omarchy bar defaults

bar defaults restores the shipped layout, so preserve a customized shell.json first.

Channels and system updates

Stable is the daily-use default. Edge, RC, and dev target testing or development. Before switching, read updates and recovery and prove that snapshots are reachable.

Do not bypass the integrated process with pacman -Syu or yay -Syu. Omarchy's update path combines the snapshot, migrations, configuration, and package update.

Safety rules for scripts and agents

Read --help and record the installed version.
Set an explicit working directory rather than defaulting to $HOME.
Keep passwords, tokens, and recovery keys out of command arguments.
Record files and Git diff before mutation.
Never auto-confirm disk, account, boot, or deletion operations.
Parse JSON or exit status instead of sentence text.
Redact debug output before publishing it.

The current Troubleshooting page may still show wrapper forms such as omarchy-debug and omarchy-reinstall, while the CLI and Updates pages use omarchy debug and omarchy reinstall. Prefer the form discoverable through omarchy commands on the installed system. Read snapshots and system recovery before recovery work.

Sources: Omarchy CLI and Updates.