CLI 命令全集¶
本页由 scripts/generate_command_catalog.py 从固定快照中每个可执行 bin/omarchy-* 的前 80 行元数据生成。它是架构索引，不替代命令自己的 --help。
- 快照：
ef6d9e6605b1 - 命令：430（可见 361，隐藏 69）
omarchy-*命名文件：432（其中 2 个因没有 executable bit 而不被 router 注册）- 声明需要 sudo：84
- 分组：72
分组统计¶
| 分组 | 总数 | 可见 | 隐藏 | sudo |
|---|---|---|---|---|
install |
33 | 33 | 0 | 18 |
theme |
31 | 16 | 15 | 0 |
hw |
26 | 23 | 3 | 0 |
hyprland |
24 | 19 | 5 | 0 |
remove |
23 | 22 | 1 | 19 |
launch |
22 | 21 | 1 | 0 |
update |
21 | 14 | 7 | 7 |
restart |
16 | 15 | 1 | 1 |
menu |
13 | 12 | 1 | 0 |
toggle |
13 | 12 | 1 | 1 |
refresh |
12 | 12 | 0 | 4 |
dev |
11 | 11 | 0 | 1 |
system |
10 | 6 | 4 | 1 |
audio |
9 | 9 | 0 | 0 |
pkg |
9 | 9 | 0 | 5 |
plugin |
9 | 8 | 1 | 0 |
capture |
8 | 6 | 2 | 0 |
agent |
7 | 4 | 3 | 0 |
plymouth |
7 | 7 | 0 | 3 |
notification |
6 | 5 | 1 | 0 |
brightness |
5 | 5 | 0 | 0 |
network |
5 | 5 | 0 | 0 |
setup |
5 | 5 | 0 | 5 |
voxtype |
5 | 5 | 0 | 2 |
webapp |
5 | 5 | 0 | 0 |
default |
4 | 4 | 0 | 0 |
version |
4 | 3 | 1 | 0 |
apply |
3 | 0 | 3 | 3 |
battery |
3 | 2 | 1 | 0 |
branding |
3 | 2 | 1 | 0 |
clipboard |
3 | 0 | 3 | 0 |
cmd |
3 | 2 | 1 | 0 |
drive |
3 | 3 | 0 | 1 |
font |
3 | 3 | 0 | 0 |
hibernation |
3 | 3 | 0 | 2 |
powerprofiles |
3 | 3 | 0 | 0 |
provision |
3 | 0 | 3 | 1 |
reinstall |
3 | 3 | 0 | 2 |
sudo |
3 | 3 | 0 | 2 |
tui |
3 | 3 | 0 | 0 |
weather |
3 | 3 | 0 | 0 |
bar |
2 | 1 | 1 | 0 |
bluetooth |
2 | 2 | 0 | 0 |
channel |
2 | 2 | 0 | 1 |
chromium |
2 | 0 | 2 | 0 |
debug |
2 | 2 | 0 | 1 |
games |
2 | 2 | 0 | 0 |
hook |
2 | 2 | 0 | 0 |
installed |
2 | 0 | 2 | 0 |
migrate |
2 | 2 | 0 | 0 |
shell |
2 | 1 | 1 | 0 |
show |
2 | 2 | 0 | 0 |
tailscale |
2 | 2 | 0 | 0 |
transcode |
2 | 2 | 0 | 0 |
windows |
2 | 2 | 0 | 2 |
crash |
1 | 0 | 1 | 0 |
disk |
1 | 1 | 0 | 0 |
display |
1 | 1 | 0 | 0 |
dns |
1 | 1 | 0 | 0 |
done |
1 | 0 | 1 | 0 |
file |
1 | 1 | 0 | 0 |
mise |
1 | 1 | 0 | 0 |
monitor |
1 | 1 | 0 | 0 |
osd |
1 | 1 | 0 | 0 |
power |
1 | 1 | 0 | 0 |
reminder |
1 | 1 | 0 | 0 |
screensaver |
1 | 1 | 0 | 0 |
share |
1 | 1 | 0 | 0 |
snapshot |
1 | 1 | 0 | 1 |
state |
1 | 0 | 1 | 0 |
upgrade |
1 | 1 | 0 | 1 |
upload |
1 | 0 | 1 | 0 |
标记说明¶
sudo：命令元数据声明需要提升权限；真正权限仍由目标脚本检查。hidden：不出现在常规发现界面，仍可供内部或兼容调用。- alias：完整 registry 路径才能解析的额外命令路由。
非可执行的命名文件
omarchy-remove-service-dropbox, omarchy-remove-service-tailscale 带有命令式文件名和元数据，但上游 Git mode 为 100644。router 只扫描可执行文件，所以它们不计入下面的 430 条注册命令。
agent¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy agent |
omarchy-agent |
[--inline] [--pick] |
— | Launch the default coding agent in a terminal |
omarchy agent crash |
omarchy-agent-crash |
<pid> [comm] [exe] [signal] |
— | Diagnose a crashed process with the default coding agent |
omarchy agent prompt |
omarchy-agent-prompt |
[--inline] <prompt...> |
— | Launch the default coding agent with a prompt |
omarchy agent usage claude |
omarchy-agent-usage-claude |
[--force] [--limits-only] |
hidden | Print the Claude Code usage record as JSON |
omarchy agent usage codex |
omarchy-agent-usage-codex |
[--force] [--limits-only] |
hidden | Print the Codex usage record as JSON |
omarchy agent usage fireworks |
omarchy-agent-usage-fireworks |
[--force] [--limits-only] |
hidden | Print the Fireworks usage record as JSON |
omarchy agent usage update |
omarchy-agent-usage-update |
[--force] [--limits-only] [--except <agent>] [agent...] |
— | Regenerate the AI agent usage data files |
apply¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy apply hardware |
omarchy-apply-hardware |
— | sudo, hidden | Apply Omarchy hardware-specific packages and system configuration |
omarchy apply lock |
omarchy-apply-lock |
— | sudo, hidden | Configure Quickshell lock screen authentication |
omarchy apply system |
omarchy-apply-system |
— | sudo, hidden | Apply Omarchy system setup in the installed target |
audio¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy audio input mute |
omarchy-audio-input-mute |
— | — | Toggle microphone mute. Drives the hardware mic-mute LED on laptops that expose one. |
omarchy audio input set default |
omarchy-audio-input-set-default |
<node-id> <source-name> |
— | Set the default audio input and move active streams |
omarchy audio output set default |
omarchy-audio-output-set-default |
<node-id> <sink-name> |
— | Set the default audio output and move active streams |
omarchy audio output sink |
omarchy-audio-output-sink |
[sink-name] |
— | Print the sink whose volume and mute a given output really uses |
omarchy audio output switch |
omarchy-audio-output-switch |
— | — | Switch between audio outputs while preserving the mute status |
omarchy audio output volume |
omarchy-audio-output-volume |
<raise\|lower\|mute-toggle\|+N\|-N> |
— | Adjust output volume and show the Omarchy OSD |
omarchy audio sink availability |
omarchy-audio-sink-availability |
— | — | Print PulseAudio sink availability for the shell |
omarchy audio source switch |
omarchy-audio-source-switch |
[next\|previous] |
— | Cycle to the next media source and transfer playback when the current source is playing |
omarchy audio tuning |
omarchy-audio-tuning |
<on\|off\|status\|match\|fronted-sink> [--force] |
— | Manage the speaker tuning for this laptop |
bar¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy bar |
omarchy-bar |
use <id> \| reset \| defaults \| position <top\|bottom\|left\|right> \| transparent <true\|false\|toggle> \| put <id> [placement] \| move <id> [placement] \| set <id> <key> <value> [--json] [placement] |
— | Configure the bar and its widget layout |
omarchy bar text color |
omarchy-bar-text-color |
— | hidden | Choose a legible transparent bar text color |
battery¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy battery low |
omarchy-battery-low |
<percentage> |
hidden | Send the low battery warning notification and run battery-low hooks. |
omarchy battery present |
omarchy-battery-present |
— | — | Returns true if a battery is present on the system. |
omarchy battery status |
omarchy-battery-status |
[--shell] |
— | Returns a formatted battery status string with percentage and power draw/charge. |
bluetooth¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy bluetooth device |
omarchy-bluetooth-device |
[pair\|connect\|disconnect\|forget] <address> |
— | Control a Bluetooth device |
omarchy bluetooth power |
omarchy-bluetooth-power |
<on\|off\|toggle\|is-on> |
— | Turn Bluetooth on or off, remembered across reboots |
branding¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy branding about |
omarchy-branding-about |
<image\|text\|reset> |
— | Edit, set, or reset About branding |
omarchy branding about-animation |
omarchy-branding-about-animation |
— | hidden | Shared helpers for animating the About branding (source this, don't run it). |
omarchy branding screensaver |
omarchy-branding-screensaver |
<image\|text\|reset> |
— | Edit, set, or reset screensaver branding |
brightness¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy brightness display |
omarchy-brightness-display |
[--no-osd] [--monitor name] [+N%\|N%-\|N%\|off\|on] |
— | Show or adjust brightness on the focused display. |
omarchy brightness display apple |
omarchy-brightness-display-apple |
[--no-osd] [+N%\|N%-\|N%] |
— | Show or adjust Apple Studio Display and Apple XDR Display brightness using asdcontrol. |
omarchy brightness display ddc |
omarchy-brightness-display-ddc |
<monitor> [+N%\|N%-\|N%] |
— | Show or adjust DDC/CI display brightness for a Hyprland monitor. |
omarchy brightness keyboard |
omarchy-brightness-keyboard |
[--no-osd] <up\|down\|cycle\|off\|restore> |
— | Adjust keyboard backlight brightness using available steps. |
omarchy brightness keyboard mute |
omarchy-brightness-keyboard-mute |
<on\|off> |
— | Set the mic-mute indicator LED on laptops that expose a platform::micmute LED node. |
capture¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy capture qr |
omarchy-capture-qr |
— | — | Decode a QR code from a screenshot region |
omarchy capture region |
omarchy-capture-region |
[region\|windows\|smart\|fullscreen] [--keep-freeze] [--match-monitor] \| --take-fullscreen \| --take-window \| --select-window <next\|prev\|left\|right\|up\|down> |
hidden | Pick a screen region over frozen screen content |
omarchy capture screenrecording |
omarchy-capture-screenrecording |
[--fullscreen] [--with-desktop-audio] [--with-microphone-audio] [--with-webcam] [--webcam-device=<device>] [--webcam-size=<small\|medium\|large>] [--resolution=<size>] [--stop-recording] |
— | Start or stop screen recording alias: omarchy screenrecord |
omarchy capture screenrecording with webcam |
omarchy-capture-screenrecording-with-webcam |
— | — | Pick a webcam and start a screen recording with it |
omarchy capture screenshot |
omarchy-capture-screenshot |
[smart\|region\|windows\|fullscreen] [slurp\|copy\|save] [--editor=<name>] |
— | Take a screenshot alias: omarchy screenshot |
omarchy capture text |
omarchy-capture-text |
— | — | Extract text from a screenshot region with OCR |
omarchy capture webcam list |
omarchy-capture-webcam-list |
— | hidden | List webcam devices that support video capture |
omarchy capture webcam resize |
omarchy-capture-webcam-resize |
<smaller\|larger\|reset\|small\|medium\|large> |
— | Resize the active webcam recording overlay |
channel¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy channel current |
omarchy-channel-current |
— | — | Print the active Omarchy package channel |
omarchy channel set |
omarchy-channel-set |
<stable\|rc\|edge\|dev> |
sudo | Set the Omarchy package channel. |
chromium¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy chromium copy url host |
omarchy-chromium-copy-url-host |
— | hidden | Native messaging host: copy a Chromium tab URL to the clipboard |
omarchy chromium ytdlp host |
omarchy-chromium-ytdlp-host |
— | hidden | Native messaging host: download the URL sent by the yt-dlp Chromium extension |
clipboard¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy clipboard open |
omarchy-clipboard-open |
--history-index <index> |
hidden | Open a clipboard history entry |
omarchy clipboard paste file |
omarchy-clipboard-paste-file |
[--copy-only] <mime-type> <path> |
hidden | Copy a file to the clipboard and paste it |
omarchy clipboard paste text |
omarchy-clipboard-paste-text |
[--shift-insert] [--copy-only] [--history-index <index>\|<text>] |
hidden | Copy text to the clipboard and type or paste it |
cmd¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy cmd missing |
omarchy-cmd-missing |
— | — | Check whether any required commands are missing |
omarchy cmd present |
omarchy-cmd-present |
— | — | Check whether all required commands are available |
omarchy cmd terminal cwd |
omarchy-cmd-terminal-cwd |
— | hidden | Print the current working directory of the active terminal window |
crash¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy crash watch |
omarchy-crash-watch |
— | hidden | Watch for process crashes and offer an AI diagnosis |
debug¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy debug |
omarchy-debug |
[--no-sudo] [--print] |
sudo | Print debugging information |
omarchy debug idle |
omarchy-debug-idle |
[log-lines] |
— | Show idle, screensaver, and lock diagnostics |
default¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy default agent |
omarchy-default-agent |
[pi\|omp\|opencode\|ori\|claude\|codex\|grok\|agy\|copilot\|crush] |
— | Set and launch the default coding agent |
omarchy default browser |
omarchy-default-browser |
[chromium\|chrome\|brave\|brave-origin\|edge\|firefox\|zen] |
— | Set the default browser for Omarchy and XDG handlers |
omarchy default editor |
omarchy-default-editor |
[code\|cursor\|zed\|sublime_text\|helix\|vim\|emacs\|nvim] |
— | Set the default editor used by omarchy-launch-editor |
omarchy default terminal |
omarchy-default-terminal |
[alacritty\|foot\|ghostty\|kitty] |
— | Set the default terminal used by xdg-terminal-exec |
dev¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy dev add migration |
omarchy-dev-add-migration |
[--no-edit] |
— | Create a new Omarchy migration in the current source tree. |
omarchy dev benchmark cli |
omarchy-dev-benchmark-cli |
[--repeat=<count>] |
— | Measure Omarchy CLI response times |
omarchy dev benchmark theme switcher |
omarchy-dev-benchmark-theme-switcher |
[--repeat=<count>] [--keep-cache] |
— | Measure theme switcher cache and selector prep times alias: omarchy dev benchmark theme-switcher |
omarchy dev font |
omarchy-dev-font |
[list\|add] <name> <svg-file-or-url> [--codepoint U+E9xx] [--font PATH] |
— | Add branded glyphs to the Omarchy icon font |
omarchy dev install ydoo |
omarchy-dev-install-ydoo |
— | sudo | Install and enable ydotool mouse automation for Omarchy development |
omarchy dev link |
omarchy-dev-link |
<path-to-checkout> [--no-reboot] |
— | Point Omarchy at a local checkout after reboot |
omarchy dev pkg test |
omarchy-dev-pkg-test |
[package-name] [path-to-checkout] |
— | Build and install an Omarchy package from a local checkout |
omarchy dev status |
omarchy-dev-status |
— | — | Show the current Omarchy dev-link state |
omarchy dev theme preview |
omarchy-dev-theme-preview |
[theme-name\|theme-dir\|colors.toml] [--no-color] [--no-osc\|--osc] |
— | Preview an Omarchy theme palette in the terminal |
omarchy dev ui preview |
omarchy-dev-ui-preview |
[section] |
— | Open the omarchy-shell dev gallery (qs.Ui kit preview) |
omarchy dev unlink |
omarchy-dev-unlink |
[--no-reboot] |
— | Restore Omarchy to the package install after reboot |
disk¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy disk speedtest |
omarchy-disk-speedtest |
[target-dir] |
— | Measure live disk read and write speed |
display¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy display text size |
omarchy-display-text-size |
[size\|reset] |
— | Scale text everywhere — omarchy shell, GTK apps, and terminals |
dns¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy dns |
omarchy-dns |
[Cloudflare\|Google\|DHCP\|Custom] |
— | Show or configure the system DNS provider |
done¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy done |
omarchy-done |
<check\|mark\|ensure> <name> |
hidden | Check or mark completed Omarchy setup tasks |
drive¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy drive info |
omarchy-drive-info |
<drive> |
— | Print drive information such as size, model, and mount details |
omarchy drive password |
omarchy-drive-password |
— | sudo | Set a new encryption password for a drive selected. |
omarchy drive select |
omarchy-drive-select |
— | — | Select a drive from a list with info that includes space and brand. Used by omarchy-drive-password. |
file¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy file select |
omarchy-file-select |
[--title <title>] [--multiple] [--directory] [--extensions "<ext ext...>"] |
— | Pick files with the desktop file chooser |
font¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy font current |
omarchy-font-current |
— | — | Show current monospace font |
omarchy font list |
omarchy-font-list |
— | — | List available monospace fonts |
omarchy font set |
omarchy-font-set |
<font-name> |
— | Set the system monospace font |
games¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy games retro cores |
omarchy-games-retro-cores |
— | — | List installed RetroArch core names |
omarchy games retro install |
omarchy-games-retro-install |
[core path-to-game] |
— | Create a desktop launcher for a RetroArch game |
hibernation¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy hibernation available |
omarchy-hibernation-available |
— | — | Check if hibernation is supported |
omarchy hibernation remove |
omarchy-hibernation-remove |
— | sudo | Remove hibernation setup including swap and boot resume settings |
omarchy hibernation setup |
omarchy-hibernation-setup |
[--force] [--no-rebuild] |
sudo | Set up hibernation with swap and boot resume configuration |
hook¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy hook |
omarchy-hook |
[name] [args...] |
— | Run a named hook from ~/.config/omarchy/hooks/ |
omarchy hook install |
omarchy-hook-install |
<type> <file> |
— | Install a hook into ~/.config/omarchy/hooks/ |
hw¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy hw asus expertbook b9406 |
omarchy-hw-asus-expertbook-b9406 |
— | — | Detect ASUS ExpertBook B9406 series laptops on Intel Panther Lake. |
omarchy hw asus rog |
omarchy-hw-asus-rog |
— | — | Detect whether the computer is an Asus ROG machine. |
omarchy hw asus zenbook ux5406aa |
omarchy-hw-asus-zenbook-ux5406aa |
— | — | Detect ASUS Zenbook UX5406AA series laptops on Intel Panther Lake. |
omarchy hw clamshell |
omarchy-hw-clamshell |
— | hidden | Returns true when clamshell mode is active |
omarchy hw dell xps haptic touchpad |
omarchy-hw-dell-xps-haptic-touchpad |
— | — | Match Dell XPS systems with the Synaptics haptic touchpad. |
omarchy hw dell xps oled |
omarchy-hw-dell-xps-oled |
— | — | Match Dell XPS systems with LG OLED panel on Intel Panther Lake (Xe3) GPU. |
omarchy hw display |
omarchy-hw-display |
— | — | Print the most likely display backlight device. |
omarchy hw external monitors |
omarchy-hw-external-monitors |
— | — | Returns true when an external monitor is physically connected. |
omarchy hw fingerprint |
omarchy-hw-fingerprint |
— | hidden | Returns true when a fingerprint reader is present |
omarchy hw framework16 |
omarchy-hw-framework16 |
— | — | Detect whether the computer is a Framework Laptop 16. |
omarchy hw hybrid gpu |
omarchy-hw-hybrid-gpu |
— | — | Detect whether the system has an active hybrid GPU configuration |
omarchy hw intel |
omarchy-hw-intel |
— | — | Detect whether the computer has an Intel CPU. |
omarchy hw intel ptl |
omarchy-hw-intel-ptl |
— | — | Detect whether the computer has an Intel Panther Lake GPU. |
omarchy hw intel sof |
omarchy-hw-intel-sof |
— | — | Detect an Intel SOF-capable audio DSP |
omarchy hw laptop |
omarchy-hw-laptop |
— | — | Returns true when running on a laptop (has a lid or laptop chassis). |
omarchy hw laptop closed |
omarchy-hw-laptop-closed |
— | hidden | Returns true when the laptop lid is closed |
omarchy hw match |
omarchy-hw-match |
<pattern> |
— | Match against the computer's DMI product name or product family (case-insensitive). |
omarchy hw nvidia |
omarchy-hw-nvidia |
— | — | Detect whether the computer has an NVIDIA GPU. |
omarchy hw nvidia gsp |
omarchy-hw-nvidia-gsp |
— | — | Detect whether the computer has an NVIDIA GPU with GSP firmware (Turing or newer). |
omarchy hw nvidia without gsp |
omarchy-hw-nvidia-without-gsp |
— | — | Detect whether the computer has an NVIDIA GPU without GSP firmware (Maxwell/Pascal/Volta). |
omarchy hw recover internal monitor |
omarchy-hw-recover-internal-monitor |
— | — | Clear the internal-monitor-disable toggle if no external display is connected. |
omarchy hw surface |
omarchy-hw-surface |
— | — | Detect whether the computer is a Microsoft Surface device. |
omarchy hw touchpad |
omarchy-hw-touchpad |
— | — | Print the detected Hyprland touchpad or trackpad device name |
omarchy hw touchscreen |
omarchy-hw-touchscreen |
— | — | Print the detected Hyprland touchscreen or tablet device name |
omarchy hw vulkan |
omarchy-hw-vulkan |
— | — | Detect whether Vulkan is available. |
omarchy hw webcam |
omarchy-hw-webcam |
— | — | Check whether a webcam is available |
hyprland¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy hyprland focus app |
omarchy-hyprland-focus-app |
<app-name> |
— | Focus a Hyprland window by application identity |
omarchy hyprland monitor clamshell |
omarchy-hyprland-monitor-clamshell |
— | hidden | Apply clamshell display state to Hyprland monitors |
omarchy hyprland monitor external active |
omarchy-hyprland-monitor-external-active |
— | hidden | Returns true when Hyprland has an active external monitor |
omarchy hyprland monitor focused |
omarchy-hyprland-monitor-focused |
— | — | Print the name of the currently focused Hyprland monitor. |
omarchy hyprland monitor focused apple |
omarchy-hyprland-monitor-focused-apple |
[monitor] |
— | Return success if the focused or named Hyprland monitor is an Apple display. |
omarchy hyprland monitor internal |
omarchy-hyprland-monitor-internal |
<on\|off\|toggle\|recover> |
— | Enable, disable, toggle, or recover the internal laptop display |
omarchy hyprland monitor internal mirror |
omarchy-hyprland-monitor-internal-mirror |
<on\|off\|toggle\|recover> |
— | Enable, disable, toggle, or recover mirroring the internal display to an external monitor |
omarchy hyprland monitor laptop |
omarchy-hyprland-monitor-laptop |
— | — | Print the name of the built-in laptop display, including disabled outputs. |
omarchy hyprland monitor modeless |
omarchy-hyprland-monitor-modeless |
— | hidden | Returns true when Hyprland has an enabled monitor with no mode |
omarchy hyprland monitor scaling |
omarchy-hyprland-monitor-scaling |
[up\|down\|SCALE] |
— | Show, set, or adjust focused Hyprland monitor scaling |
omarchy hyprland monitor watch |
omarchy-hyprland-monitor-watch |
— | — | Watch Hyprland monitor events and recover monitor toggles when a monitor is removed |
omarchy hyprland reload guard |
omarchy-hyprland-reload-guard |
— | hidden | Pause or resume Hyprland config auto-reload around package transactions. |
omarchy hyprland session locked |
omarchy-hyprland-session-locked |
— | hidden | Returns true when the compositor holds a session lock |
omarchy hyprland toggle |
omarchy-hyprland-toggle |
<flag-name> [on\|off\|toggle] |
— | Toggle permanent Hyprland flags by copying them into a directory that's sourced entirely. |
omarchy hyprland toggle disabled |
omarchy-hyprland-toggle-disabled |
<flag-name> |
— | Check if a Hyprland toggle is currently disabled (missing). |
omarchy hyprland toggle enabled |
omarchy-hyprland-toggle-enabled |
<flag-name> |
— | Check if a Hyprland toggle is currently enabled. |
omarchy hyprland window close all |
omarchy-hyprland-window-close-all |
— | — | Close all open windows |
omarchy hyprland window gaps toggle |
omarchy-hyprland-window-gaps-toggle |
— | — | Toggles the window gaps globally between no gaps and the default. |
omarchy hyprland window pop |
omarchy-hyprland-window-pop |
[width height x y] |
— | Toggle to pop-out a tile to stay fixed on a display basis. |
omarchy hyprland window single square aspect toggle |
omarchy-hyprland-window-single-square-aspect-toggle |
— | — | Toggle single-window square aspect ratio. |
omarchy hyprland window tiled fullscreen toggle |
omarchy-hyprland-window-tiled-fullscreen-toggle |
— | — | Toggle tiled fullscreen for the focused Hyprland window |
omarchy hyprland window transparency toggle |
omarchy-hyprland-window-transparency-toggle |
— | — | Toggles transparency for the currently focused window. |
omarchy hyprland window width |
omarchy-hyprland-window-width |
<save\|restore> |
— | Save or restore the focused Hyprland window width |
omarchy hyprland workspace layout toggle |
omarchy-hyprland-workspace-layout-toggle |
— | — | Toggle the layout on the current active workspace between dwindle and scrolling |
install¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy install ai chatgpt |
omarchy-install-ai-chatgpt |
— | sudo | Install the ChatGPT desktop app |
omarchy install and launch |
omarchy-install-and-launch |
<display-name> <packages> <desktop-id> |
— | Install a packaged app and launch it once it finishes |
omarchy install app |
omarchy-install-app |
<display-name> <packages> |
— | Install a packaged app, surfacing the install in a floating terminal |
omarchy install browser |
omarchy-install-browser |
<chromium\|chrome\|brave\|brave-origin\|edge\|firefox\|zen> |
— | Install a supported browser |
omarchy install chromium copy url |
omarchy-install-chromium-copy-url |
— | — | Install the native messaging host for the Copy URL Chromium extension |
omarchy install chromium google account |
omarchy-install-chromium-google-account |
— | — | Allow Chromium to sign in to Google accounts by adding the required OAuth credentials |
omarchy install chromium ytdlp |
omarchy-install-chromium-ytdlp |
— | — | Install the native messaging host for the yt-dlp Chromium extension |
omarchy install dev-env |
omarchy-install-dev-env |
<ruby\|node\|bun\|deno\|go\|laravel\|symfony\|php\|python\|elixir\|phoenix\|rust\|java\|zig\|ocaml\|dotnet\|clojure\|scala> |
sudo | Install a supported development environment |
omarchy install docker dbs |
omarchy-install-docker-dbs |
— | sudo | Install one of the supported databases in a Docker container with the suitable development options. |
omarchy install editor emacs |
omarchy-install-editor-emacs |
— | — | Install Emacs with Omarchy theme and font integration via the omarchy-emacs AUR package |
omarchy install editor helix |
omarchy-install-editor-helix |
— | — | Install Helix and configure it to use the current Omarchy theme |
omarchy install editor vscode |
omarchy-install-editor-vscode |
— | — | Install VS Code and configure Omarchy defaults for secrets, updates, and theme |
omarchy install editor zed |
omarchy-install-editor-zed |
— | — | Install Zed Editor and configure it with the current Omarchy theme |
omarchy install font |
omarchy-install-font |
<display-name> <package> <family> |
— | Install a Nerd Font package and switch the system to it |
omarchy install gaming battlenet |
omarchy-install-gaming-battlenet |
— | sudo | Install Battle.net standalone via umu-launcher + GE-Proton (no Steam, no Lutris, no Heroic). |
omarchy install gaming geforce-now |
omarchy-install-gaming-geforce-now |
— | — | Install and launch Geforce Now. |
omarchy install gaming gpu-lib32 |
omarchy-install-gaming-gpu-lib32 |
— | sudo | Install lib32 graphics drivers (Vulkan + NVIDIA) for any detected GPUs. |
omarchy install gaming heroic |
omarchy-install-gaming-heroic |
— | sudo | Install Heroic Games Launcher (Epic, GOG, Amazon Prime Gaming) with graphics drivers. |
omarchy install gaming lutris |
omarchy-install-gaming-lutris |
— | sudo | Install Lutris with Wine + DXVK for running Windows games (Battle.net, EA, Ubisoft Connect, etc.) |
omarchy install gaming retroarch |
omarchy-install-gaming-retroarch |
— | — | Install RetroArch with the full libretro core set plus FBNeo and a ~/Games ROM directory. |
omarchy install gaming steam |
omarchy-install-gaming-steam |
— | sudo | Install Steam and graphics drivers selected for this system |
omarchy install gaming xbox-cloud |
omarchy-install-gaming-xbox-cloud |
— | — | Install Xbox Cloud Gaming as a web app and launch it. |
omarchy install gaming xbox-controllers |
omarchy-install-gaming-xbox-controllers |
— | sudo | Install support for using Xbox controllers with Steam/RetroArch/etc. |
omarchy install preinstalls |
omarchy-install-preinstalls |
— | sudo | Restore the preinstalled Omarchy applications (web apps, TUIs, and selected packages). |
omarchy install service 1password |
omarchy-install-service-1password |
— | sudo | Install 1Password and its Chromium extension. |
omarchy install service dropbox |
omarchy-install-service-dropbox |
— | — | Install and start the Dropbox service. Must then be authenticated via the web. |
omarchy install service nordvpn |
omarchy-install-service-nordvpn |
— | sudo | Install the NordVPN service with optional GUI. |
omarchy install service once |
omarchy-install-service-once |
— | sudo | Install the ONCE service, enable its background service, and launch the TUI. |
omarchy install service signal |
omarchy-install-service-signal |
— | sudo | Install Signal and launch it. |
omarchy install service spotify |
omarchy-install-service-spotify |
— | sudo | Install Spotify. |
omarchy install service sunshine |
omarchy-install-service-sunshine |
— | sudo | Install Sunshine and open Moonlight streaming ports for LAN and Tailscale. |
omarchy install service tailscale |
omarchy-install-service-tailscale |
— | sudo | Install the Tailscale mesh VPN service and a web app for the Tailscale Admin Console. |
omarchy install terminal |
omarchy-install-terminal |
<alacritty\|foot\|ghostty\|kitty> |
sudo | Install one of the approved terminals and set it as the default for Omarchy (Super + Return etc). |
installed¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy installed service dropbox |
omarchy-installed-service-dropbox |
— | hidden | Check whether Dropbox is installed and running |
omarchy installed service tailscale |
omarchy-installed-service-tailscale |
— | hidden | Check whether Tailscale is installed and running |
launch¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy launch 1password |
omarchy-launch-1password |
— | — | Launch 1Password or start its installer when missing. |
omarchy launch about |
omarchy-launch-about |
— | — | Launch the fastfetch TUI that gives information about the current system. |
omarchy launch battlenet |
omarchy-launch-battlenet |
[--with-mangohud] |
— | Launch the installed Battle.net client via umu-launcher + GE-Proton. |
omarchy launch browser |
omarchy-launch-browser |
[url] |
— | Launch the default browser as determined by xdg-settings. |
omarchy launch config editor |
omarchy-launch-config-editor |
<path> |
— | Open a config file in the user's editor and surface a toast |
omarchy launch discord community |
omarchy-launch-discord-community |
— | — | Open the Omarchy Discord community in the Discord app or a browser. |
omarchy launch editor |
omarchy-launch-editor |
[--inline] <path> |
— | Launch the default editor selected via Omarchy defaults. |
omarchy launch floating terminal with presentation |
omarchy-launch-floating-terminal-with-presentation |
<command> |
— | Launch a floating terminal with the Omarchy presentation wrapper |
omarchy launch nautilus |
omarchy-launch-nautilus |
— | — | Launch Files |
omarchy launch nautilus cwd |
omarchy-launch-nautilus-cwd |
— | — | Launch Files in the active terminal's current directory |
omarchy launch or focus |
omarchy-launch-or-focus |
<window-pattern> <launch-command> |
— | Launch an app or focus an existing window matching a pattern |
omarchy launch or focus tui |
omarchy-launch-or-focus-tui |
[--app-id=<app-id>] <command> [args...] |
— | Launch a TUI or focus an existing terminal window for it |
omarchy launch or focus webapp |
omarchy-launch-or-focus-webapp |
<window-pattern> <url-and-flags...> |
— | Launch or focus on a given web app identified by the window-pattern. |
omarchy launch screensaver |
omarchy-launch-screensaver |
— | — | Launch the Omarchy screensaver in the default terminal on the system with the correct font configuration. |
omarchy launch shell |
omarchy-launch-shell |
— | hidden | Launch the Omarchy shell with its log kept in the journal |
omarchy launch signal |
omarchy-launch-signal |
— | — | Launch Signal or start its installer when missing. |
omarchy launch spotify |
omarchy-launch-spotify |
— | — | Launch Spotify or start its installer when missing. |
omarchy launch terminal |
omarchy-launch-terminal |
[command...] |
— | Launch a terminal in the active terminal's current directory |
omarchy launch terminal herdr |
omarchy-launch-terminal-herdr |
— | — | Launch or attach to the persistent herdr session in a terminal |
omarchy launch terminal tmux |
omarchy-launch-terminal-tmux |
— | — | Launch or attach to the Work tmux session in a terminal |
omarchy launch tui |
omarchy-launch-tui |
[--app-id=<app-id>] <command> [args...] |
— | Launch a TUI command in the default terminal with Omarchy styling |
omarchy launch webapp |
omarchy-launch-webapp |
<url> |
— | Launch a URL as a web app in the default supported browser |
menu¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy menu |
omarchy-menu |
[toggle\|summon\|close\|refresh\|ping] [route] |
— | Control the Omarchy menu (toggle / summon / close / refresh) |
omarchy menu clipboard |
omarchy-menu-clipboard |
— | — | Launch the clipboard manager |
omarchy menu emoji |
omarchy-menu-emoji |
— | — | Launch emojis |
omarchy menu emoji insert |
omarchy-menu-emoji-insert |
<emoji> |
hidden | Insert an emoji into the focused application |
omarchy menu file |
omarchy-menu-file |
label paths formats [menu args...] |
— | Pick a file from a menu |
omarchy menu herdr keybindings |
omarchy-menu-herdr-keybindings |
[--print\|-p] [--config <path>] |
— | Display annotated Herdr keybindings using an interactive search menu. |
omarchy menu images |
omarchy-menu-images |
[--selected <image>] [--print-name] [--show-labels] [--filterable] [--lazy-thumbnails] [--preload] [--cache-only] <image-dir>... |
— | Open a generic image selector menu |
omarchy menu input |
omarchy-menu-input |
prompt [menu args...] |
— | Prompt for text input from a menu |
omarchy menu keybindings |
omarchy-menu-keybindings |
— | — | Display Hyprland keybindings defined in your configuration using an interactive search menu. |
omarchy menu plugin |
omarchy-menu-plugin |
<enable\|disable\|clone\|remove> |
— | Pick a shell plugin to enable, disable, clone, or remove |
omarchy menu select |
omarchy-menu-select |
prompt [option...] [-- menu args...] |
— | Pick one option from a menu |
omarchy menu timezone |
omarchy-menu-timezone |
— | — | Select and set the system timezone |
omarchy menu tmux keybindings |
omarchy-menu-tmux-keybindings |
[--print\|-p] [--config <path>] |
— | Display annotated Tmux keybindings using an interactive search menu. |
migrate¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy migrate |
omarchy-migrate |
[--pending] |
— | Run pending Omarchy migrations. |
omarchy migrate notify |
omarchy-migrate-notify |
— | — | Notify the user when Omarchy has pending migrations |
mise¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy mise install |
omarchy-mise-install |
<package> [command-name [bin-name]] |
— | Install a small mise-backed wrapper for a given tool. |
monitor¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy monitor state |
omarchy-monitor-state |
— | — | Print monitor panel state for the shell |
network¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy network band |
omarchy-network-band |
[auto\|2.4\|5\|6] |
— | Show or pin the Wi-Fi band for the active connection |
omarchy network password |
omarchy-network-password |
<interface> |
— | Print the active Wi-Fi connection's password |
omarchy network qr |
omarchy-network-qr |
[--meta] [interface] |
— | Generate a Wi-Fi QR matrix for the shell |
omarchy network speedtest |
omarchy-network-speedtest |
[down\|up] |
— | Measure live internet speed for one direction |
omarchy network status |
omarchy-network-status |
[--verbose] |
— | Print active network status for the shell |
notification¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy notification battery |
omarchy-notification-battery |
— | — | Show the current battery status notification |
omarchy notification dismiss |
omarchy-notification-dismiss |
<summary> |
— | Dismiss a notification by summary substring. Used by the first-run notifications to dismiss them after clicking for action. |
omarchy notification send |
omarchy-notification-send |
[--exec <command>] [--app-name <app-name>] [-g <glyph>] [-u <low\|normal\|critical>] [--image <path-or-uri>] <headline> [description] [notify-send options] |
— | Send an Omarchy desktop notification |
omarchy notification time |
omarchy-notification-time |
— | — | Show the current time and date notification |
omarchy notification wait |
omarchy-notification-wait |
[timeout-seconds] |
hidden | Wait for the desktop notification server to accept notifications |
omarchy notification weather |
omarchy-notification-weather |
— | — | Toggle the current weather panel |
osd¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy osd |
omarchy-osd |
[-i\|--icon <icon>] [-m\|--message <text>] [-p\|--progress <0-100>] [-d\|--duration <ms>] |
— | Show the Omarchy Quickshell on-screen display |
pkg¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy pkg add |
omarchy-pkg-add |
<packages...> |
sudo | Install Arch packages if they are missing |
omarchy pkg aur accessible |
omarchy-pkg-aur-accessible |
— | — | Returns true if the AUR is up and available. |
omarchy pkg aur add |
omarchy-pkg-aur-add |
<packages...> |
— | Add the named packages to the system from the AUR if they're missing. Returns false if it couldn't be done. |
omarchy pkg aur install |
omarchy-pkg-aur-install |
— | sudo | Show a fuzzy-finder TUI for picking new AUR packages to install. |
omarchy pkg drop |
omarchy-pkg-drop |
<packages...> |
sudo | Remove all the named packages from the system if they're installed (otherwise ignore). |
omarchy pkg install |
omarchy-pkg-install |
— | sudo | Show a fuzzy-finder TUI for picking new Arch and OPR packages to install. |
omarchy pkg missing |
omarchy-pkg-missing |
<packages...> |
— | Returns true if any of the named packages are missing from the system (or false if they're all there). |
omarchy pkg present |
omarchy-pkg-present |
<packages...> |
— | Returns true if all of the named packages are installed on the system (or false if any of them are missing). |
omarchy pkg remove |
omarchy-pkg-remove |
— | sudo | Show a fuzzy-finder TUI for picking packages installed on the system to be removed. |
plugin¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy plugin add |
omarchy-plugin-add |
[git-url] [--enable] [--yes] |
— | Add a shell plugin from git alias: omarchy plugin install |
omarchy plugin catalog |
omarchy-plugin-catalog |
— | hidden | Emit every first-party and user plugin manifest as JSON |
omarchy plugin clone |
omarchy-plugin-clone |
<source-id> [--edit] |
— | Clone a built-in Omarchy shell plugin into your own config |
omarchy plugin disable |
omarchy-plugin-disable |
<id> |
— | Disable a shell plugin |
omarchy plugin enable |
omarchy-plugin-enable |
<id> [placement] |
— | Enable a shell plugin |
omarchy plugin list |
omarchy-plugin-list |
[--json] |
— | List discovered shell plugins |
omarchy plugin remove |
omarchy-plugin-remove |
[id] [--yes] |
— | Remove an installed shell plugin alias: omarchy plugin rm |
omarchy plugin update |
omarchy-plugin-update |
[id] [--yes] |
— | Update installed git-managed plugins |
omarchy plugin validate |
omarchy-plugin-validate |
<plugin-folder> |
— | Validate a plugin folder against the Omarchy plugin manifest schema |
plymouth¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy plymouth current |
omarchy-plymouth-current |
— | — | Show which theme is styling the Plymouth boot screen |
omarchy plymouth list |
omarchy-plymouth-list |
— | — | List themes that can style the Plymouth boot screen |
omarchy plymouth preview |
omarchy-plymouth-preview |
<background-hex> <text-hex> <path-to-logo.png> <output-path> |
— | Preview a Plymouth boot screen with custom colors and logo |
omarchy plymouth reset |
omarchy-plymouth-reset |
— | sudo | Restore the default Omarchy Plymouth boot theme and SDDM login screen |
omarchy plymouth set |
omarchy-plymouth-set |
<background-hex> <text-hex> <path-to-logo.png> |
sudo | Set the Plymouth boot theme colors and logo |
omarchy plymouth set by theme |
omarchy-plymouth-set-by-theme |
<theme-name> |
sudo | Set the Plymouth boot theme from an Omarchy theme |
omarchy plymouth switcher |
omarchy-plymouth-switcher |
— | — | Open the Plymouth unlock screen switcher |
power¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy power present |
omarchy-power-present |
— | — | Returns true if external power is connected. |
powerprofiles¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy powerprofiles init |
omarchy-powerprofiles-init |
— | — | Set the correct power profile on boot based on current AC/battery state. |
omarchy powerprofiles list |
omarchy-powerprofiles-list |
[--active-state] |
— | Returns a list of all the available power profiles on the system. |
omarchy powerprofiles set |
omarchy-powerprofiles-set |
[autodetect\|ac\|battery] [power-saver\|balanced\|performance] |
— | Set and remember the power profile for AC or battery use |
provision¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy provision first run |
omarchy-provision-first-run |
[--force] |
hidden | Finish first-login setup for Omarchy. |
omarchy provision owner |
omarchy-provision-owner |
— | sudo, hidden | First-boot provisioning: create the user on a machine installed in deferred provisioning |
omarchy provision user |
omarchy-provision-user |
— | hidden | Finalize Omarchy user setup (runtime tweaks /etc/skel can't do) |
refresh¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy refresh applications |
omarchy-refresh-applications |
— | — | Ensure default application launchers and mise wrappers are installed. |
omarchy refresh chromium |
omarchy-refresh-chromium |
— | — | Refresh the ~/.config/chromium-flags.conf file from the Omarchy defaults. |
omarchy refresh config |
omarchy-refresh-config |
<config-path> |
— | Copy a shipped user config from $OMARCHY_PATH/config into ~/.config (backs up your version). |
omarchy refresh herdr |
omarchy-refresh-herdr |
— | — | Overwrite the user herdr config with the Omarchy default and reload herdr. |
omarchy refresh hyprland |
omarchy-refresh-hyprland |
— | — | Overwrite all the user Hyprland Lua configs in ~/.config/hypr with the Omarchy defaults. |
omarchy refresh hyprsunset |
omarchy-refresh-hyprsunset |
— | — | Overwrite the user config for hyprsunset with the Omarchy default and restart the service. |
omarchy refresh limine |
omarchy-refresh-limine |
— | sudo | Overwrite the user config for the Limine bootloader and rebuild it. |
omarchy refresh pacman |
omarchy-refresh-pacman |
— | sudo | Overwrite the package configuration for /etc/pacman with the Omarchy default of using its dedicated mirrors and repositories, then update all packages. |
omarchy refresh plymouth |
omarchy-refresh-plymouth |
— | sudo | Overwrite the user config for the Plymouth drive decryption and boot sequence with the Omarchy default and rebuild it. |
omarchy refresh sddm |
omarchy-refresh-sddm |
— | sudo | Refresh the SDDM theme from default |
omarchy refresh shell |
omarchy-refresh-shell |
— | — | Reset shell.json to Omarchy defaults |
omarchy refresh tmux |
omarchy-refresh-tmux |
— | — | Overwrite the user tmux config with the Omarchy default and reload tmux. |
reinstall¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy reinstall |
omarchy-reinstall |
— | sudo | Reinstall Omarchy packages and reset default configs |
omarchy reinstall configs |
omarchy-reinstall-configs |
— | — | Reset Omarchy user configs and shipped defaults in $HOME (destructive) |
omarchy reinstall pkgs |
omarchy-reinstall-pkgs |
— | sudo | Reinstall all default Omarchy packages from the stable channel |
reminder¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy reminder |
omarchy-reminder |
[-i\|--interactive] \| <minutes> [message] \| show [-j\|--json] \| clear |
— | Set and show lightweight desktop notification reminders |
remove¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy remove ai chatgpt |
omarchy-remove-ai-chatgpt |
— | sudo | Remove the ChatGPT desktop app along with its configuration and caches. |
omarchy remove ai grok bot |
omarchy-remove-ai-grok-bot |
— | sudo | Remove Grok Bot along with its settings and data. |
omarchy remove ai lm studio |
omarchy-remove-ai-lm-studio |
— | sudo | Remove LM Studio along with its configuration and every model it downloaded. |
omarchy remove ai ollama |
omarchy-remove-ai-ollama |
— | sudo | Remove Ollama along with every model it pulled. |
omarchy remove ai t3 code |
omarchy-remove-ai-t3-code |
— | sudo | Remove T3 Code along with its configuration and workspaces. |
omarchy remove browser |
omarchy-remove-browser |
<chrome\|brave\|brave-origin\|edge\|firefox\|zen> |
sudo | Remove a supported browser and clean up Omarchy browser defaults |
omarchy remove dev env |
omarchy-remove-dev-env |
<ruby\|node\|bun\|deno\|go\|php\|laravel\|symfony\|python\|elixir\|phoenix\|zig\|rust\|java\|dotnet\|ocaml\|clojure\|scala> |
sudo | Remove a development environment that was previously installed via omarchy-install-dev-env. |
omarchy remove gaming battlenet |
omarchy-remove-gaming-battlenet |
— | — | Remove Battle.net, its Proton prefix, installed games, and desktop entry. |
omarchy remove gaming geforce-now |
omarchy-remove-gaming-geforce-now |
— | — | Remove the GeForce NOW Flatpak app and its data. |
omarchy remove gaming heroic |
omarchy-remove-gaming-heroic |
— | sudo | Remove Heroic Games Launcher and its game libraries, configs, and caches. |
omarchy remove gaming lutris |
omarchy-remove-gaming-lutris |
— | sudo | Remove Lutris, Wine, umu-launcher, and all their configs and caches. |
omarchy remove gaming minecraft |
omarchy-remove-gaming-minecraft |
— | sudo | Remove the Minecraft launcher along with its worlds, mods, and caches. |
omarchy remove gaming retroarch |
omarchy-remove-gaming-retroarch |
— | sudo | Remove RetroArch, all libretro cores, and its config/saves. Leaves ~/Games/roms and ~/Games/bios alone. |
omarchy remove gaming steam |
omarchy-remove-gaming-steam |
— | sudo | Remove Steam and all of its game libraries, configs, and caches. |
omarchy remove gaming xbox cloud |
omarchy-remove-gaming-xbox-cloud |
— | — | Remove the Xbox Cloud Gaming web app. |
omarchy remove gaming xbox-controllers |
omarchy-remove-gaming-xbox-controllers |
— | sudo | Remove the xpadneo Xbox controller driver and undo its module/blacklist config. |
omarchy remove launcher entry |
omarchy-remove-launcher-entry |
<desktop-id> <name> |
sudo, hidden | Remove or uninstall the selected launcher entry |
omarchy remove preinstalls |
omarchy-remove-preinstalls |
— | — | Remove preinstalled Omarchy applications (web apps, TUIs, and selected packages). |
omarchy remove security fido2 |
omarchy-remove-security-fido2 |
— | sudo | Remove FIDO2 authentication from sudo and polkit |
omarchy remove security fingerprint |
omarchy-remove-security-fingerprint |
— | sudo | Remove fingerprint authentication from sudo, polkit, and lock screen |
omarchy remove security sshd |
omarchy-remove-security-sshd |
— | sudo | Disable the OpenSSH server, close the firewall port, and optionally remove authorized keys |
omarchy remove service 1password |
omarchy-remove-service-1password |
— | sudo | Remove 1Password and its Chromium extension. |
omarchy remove service sunshine |
omarchy-remove-service-sunshine |
— | sudo | Remove Sunshine and close Omarchy-managed Moonlight streaming ports. |
restart¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy restart app |
omarchy-restart-app |
<application-name> [application-args...] |
— | Restart an application by killing it and relaunching via uwsm. |
omarchy restart audio |
omarchy-restart-audio |
— | — | Restart audio services and recover stuck USB audio devices. |
omarchy restart bluetooth |
omarchy-restart-bluetooth |
— | — | Unblock and restart the bluetooth service. |
omarchy restart btop |
omarchy-restart-btop |
— | — | Reload btop configuration (used by the Omarchy theme switching). |
omarchy restart gum |
omarchy-restart-gum |
— | hidden | Export the current theme's gum styling into the environment |
omarchy restart helix |
omarchy-restart-helix |
— | — | Reload Helix configuration |
omarchy restart herdr |
omarchy-restart-herdr |
— | — | Reload herdr if running with the latest configuration |
omarchy restart hyprctl |
omarchy-restart-hyprctl |
— | — | Reload hyprland configuration (used by the Omarchy theme switching). |
omarchy restart hyprsunset |
omarchy-restart-hyprsunset |
— | — | Restart the hyprsunset service (used for blue light filtering/night light). |
omarchy restart opencode |
omarchy-restart-opencode |
— | — | Reload opencode configuration (used by the Omarchy theme switching). |
omarchy restart shell |
omarchy-restart-shell |
— | — | Restart the Omarchy shell |
omarchy restart terminal |
omarchy-restart-terminal |
— | — | Reload supported terminal emulators after config changes |
omarchy restart tmux |
omarchy-restart-tmux |
— | — | Restart tmux if running with the latest configuration |
omarchy restart trackpad |
omarchy-restart-trackpad |
— | sudo | Reset the trackpad by unbinding and rebinding its driver. |
omarchy restart wifi |
omarchy-restart-wifi |
— | — | Unblock and restart the Wi-Fi service. |
omarchy restart xcompose |
omarchy-restart-xcompose |
— | — | Restart the XCompose input method service (fcitx5) to apply new compose key settings. |
screensaver¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy screensaver |
omarchy-screensaver |
— | — | Run the Omarchy screensaver using random effects from TTE. |
setup¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy setup direct boot |
omarchy-setup-direct-boot |
— | sudo | Add or remove an EFI boot entry for the Omarchy UKI, allowing the system to boot directly |
omarchy setup factory reset |
omarchy-system-factory-reset |
— | sudo | Factory-reset this machine back to its freshly-installed state |
omarchy setup security fido2 |
omarchy-setup-security-fido2 |
— | sudo | Set up FIDO2 authentication for sudo and polkit |
omarchy setup security fingerprint |
omarchy-setup-security-fingerprint |
— | sudo | Set up fingerprint authentication for sudo, polkit, and lock screen |
omarchy setup security sshd |
omarchy-setup-security-sshd |
[--key=<public-key>] [--gh-keys <github-username>] |
sudo | Set up the OpenSSH server, open the firewall, and authorize an SSH key |
share¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy share |
omarchy-menu-share |
<clipboard\|file\|folder> [path...] |
— | Share clipboard, files, or folders with LocalSend |
shell¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy shell |
omarchy-shell |
[-q] <target> <method> [args...] |
— | Send an IPC call to the running Omarchy shell |
omarchy shell config |
omarchy-shell-config |
— | hidden | Shared helpers for editing ~/.config/omarchy/shell.json (source this, don't run it). |
show¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy show done |
omarchy-show-done |
— | — | Display a "Done!" message with a spinner and wait for user to press any key. |
omarchy show logo |
omarchy-show-logo |
— | — | Display the Omarchy logo in the terminal using green color. |
snapshot¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy snapshot |
omarchy-snapshot |
<create\|restore> |
sudo | Create or restore system snapshots with snapper |
state¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy state |
omarchy-state |
<set\|clear> <state-name-or-pattern> |
hidden | Manage persistent state files for Omarchy toggles and settings. |
sudo¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy sudo keepalive |
omarchy-sudo-keepalive |
— | sudo | Prompt for sudo once and keep the credential alive in the background. |
omarchy sudo passwordless |
omarchy-sudo-passwordless |
[MINUTES] |
sudo | Toggle passwordless sudo for the current user. |
omarchy sudo reset |
omarchy-sudo-reset |
— | — | Reset the sudo lockout/faillock for the current user. |
system¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy system factory reset finish |
omarchy-system-factory-reset-finish |
— | sudo, hidden | First-boot worker that finishes an omarchy-system-factory-reset reset |
omarchy system lid close |
omarchy-system-lid-close |
— | hidden | Lock and reconcile displays when the laptop lid closes |
omarchy system lock |
omarchy-system-lock |
— | — | Lock the computer and turn off the display |
omarchy system logout |
omarchy-system-logout |
— | — | Log out after closing application windows alias: omarchy logout |
omarchy system reboot |
omarchy-system-reboot |
— | — | Reboot after closing application windows alias: omarchy reboot |
omarchy system shutdown |
omarchy-system-shutdown |
— | — | Shut down after closing application windows alias: omarchy shutdown |
omarchy system sleep lock |
omarchy-system-sleep-lock |
— | hidden | Lock before suspend and wait for the session lock to become secure |
omarchy system sleep monitor |
omarchy-system-sleep-monitor |
— | hidden | Monitor sleep preparation and lock before suspend |
omarchy system stats |
omarchy-system-stats |
[--bar-widget] |
— | Print CPU and memory stats for the shell |
omarchy system wake |
omarchy-system-wake |
— | — | Wake displays and restore brightness after idle |
tailscale¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy tailscale receive |
omarchy-tailscale-receive |
[--once] [directory] |
— | Save incoming Taildrop files and announce them |
omarchy tailscale send |
omarchy-tailscale-send |
<machine> [file...] |
— | Send files to a machine on your tailnet with Taildrop |
theme¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy theme bg cache |
omarchy-theme-bg-cache |
— | — | Cache background switcher thumbnails for the current theme |
omarchy theme bg current |
omarchy-theme-bg-current |
— | — | Show current background |
omarchy theme bg install |
omarchy-theme-bg-install |
— | — | Open the current theme's user background folder |
omarchy theme bg next |
omarchy-theme-bg-next |
— | — | Cycle to the next background for the current theme |
omarchy theme bg set |
omarchy-theme-bg-set |
<path-to-image> |
— | Set the current background image |
omarchy theme bg-switcher |
omarchy-theme-bg-switcher |
— | — | Open the Omarchy background switcher alias: omarchy background |
omarchy theme color |
omarchy-theme-color |
[--file <colors.toml>] (--all \| --raw \| <key> [fallback]) |
hidden | Resolve semantic colors from an Omarchy theme colors.toml |
omarchy theme colors from alacritty |
omarchy-theme-colors-from-alacritty |
<theme-dir> |
hidden | Generate a theme's colors.toml from its alacritty.toml palette |
omarchy theme current |
omarchy-theme-current |
— | — | Show current theme |
omarchy theme dir |
omarchy-theme-dir |
<theme-name> |
— | Print the directory holding a theme, preferring a user-installed copy |
omarchy theme extras |
omarchy-theme-extras |
— | — | List the user-installed themes that came from a git clone |
omarchy theme install |
omarchy-theme-install |
[git-repo-url] |
— | Install a theme from a git repository |
omarchy theme list |
omarchy-theme-list |
— | — | List available themes |
omarchy theme osc |
omarchy-theme-osc |
— | hidden | Print OSC sequences for an Omarchy color theme |
omarchy theme refresh |
omarchy-theme-refresh |
— | — | Refresh the current theme from its templates. |
omarchy theme remove |
omarchy-theme-remove |
[theme-name] |
— | Remove a user-installed theme |
omarchy theme set |
omarchy-theme-set |
<theme-name> |
— | Apply an Omarchy theme |
omarchy theme set browser |
omarchy-theme-set-browser |
— | hidden | Apply the current theme color to Chromium, Chrome, Edge, and Brave |
omarchy theme set claude |
omarchy-theme-set-claude |
[--activate] |
hidden | Sync the generated Omarchy theme to Claude Code |
omarchy theme set foot |
omarchy-theme-set-foot |
— | hidden | Apply current Omarchy theme colors to running Foot terminals |
omarchy theme set gnome |
omarchy-theme-set-gnome |
— | hidden | Apply the current theme to GNOME color mode and icon settings |
omarchy theme set keyboard |
omarchy-theme-set-keyboard |
— | hidden | Apply the current theme keyboard color to supported keyboards |
omarchy theme set keyboard asus rog |
omarchy-theme-set-keyboard-asus-rog |
— | hidden | Apply the current theme keyboard color to ASUS ROG keyboards |
omarchy theme set keyboard f16 |
omarchy-theme-set-keyboard-f16 |
— | hidden | Apply the current theme keyboard color to Framework Laptop 16 keyboards |
omarchy theme set obsidian |
omarchy-theme-set-obsidian |
— | hidden | Sync Omarchy theme to all Obsidian vaults |
omarchy theme set pi |
omarchy-theme-set-pi |
[--activate] |
hidden | Sync the generated Omarchy Pi theme |
omarchy theme set templates |
omarchy-theme-set-templates |
— | hidden | Generate themed config files from Omarchy templates |
omarchy theme set tmux |
omarchy-theme-set-tmux |
— | hidden | Sync current Omarchy theme environment into tmux |
omarchy theme set vscode |
omarchy-theme-set-vscode |
— | hidden | Sync Omarchy theme to VS Code, VSCodium, and Cursor |
omarchy theme switcher |
omarchy-theme-switcher |
— | — | Open the Omarchy theme switcher |
omarchy theme update |
omarchy-theme-update |
— | — | Update user-installed git themes |
toggle¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy toggle |
omarchy-toggle |
<flag-name> [toggle\|on\|off] |
— | Toggle Omarchy features between enabled and disabled |
omarchy toggle bar |
omarchy-toggle-bar |
[toggle\|on\|off] |
— | Toggle bar visibility without killing the Omarchy shell |
omarchy toggle crash capture |
omarchy-toggle-crash-capture |
— | — | Toggle crash capture notifications |
omarchy toggle enabled |
omarchy-toggle-enabled |
<flag-name> |
— | Check if a toggle is enabled (flag file exists) |
omarchy toggle hybrid gpu |
omarchy-toggle-hybrid-gpu |
— | sudo | Toggle dedicated vs integrated GPU mode via supergfxd (for hybrid gpu laptops, like Asus G14). |
omarchy toggle idle |
omarchy-toggle-idle |
[toggle\|stay-awake\|allow-idle\|status] |
— | Toggle idle behavior so the system either idles normally or stays awake |
omarchy toggle input device |
omarchy-toggle-input-device |
<touchpad\|touchscreen> [on\|off\|toggle] |
hidden | Enable, disable, or toggle a Hyprland input device |
omarchy toggle nightlight |
omarchy-toggle-nightlight |
[--status] |
— | Toggle nightlight screen temperature |
omarchy toggle notification silencing |
omarchy-toggle-notification-silencing |
— | — | Toggle notification do-not-disturb mode |
omarchy toggle screensaver |
omarchy-toggle-screensaver |
— | — | Toggle screensaver availability |
omarchy toggle suspend |
omarchy-toggle-suspend |
— | — | Toggle suspend availability in the system menu |
omarchy toggle touchpad |
omarchy-toggle-touchpad |
[on\|off\|toggle] |
— | Enable, disable, or toggle the touchpad |
omarchy toggle touchscreen |
omarchy-toggle-touchscreen |
[on\|off\|toggle] |
— | Enable, disable, or toggle the touch functionality of the screen |
transcode¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy transcode |
omarchy-transcode |
[--path path] [input] [format] [resolution] |
— | Transcode pictures and videos for sharing |
omarchy transcode ascii |
omarchy-transcode-ascii |
<input-image.svg\|png> <output-path> [--width <columns>] [--height <rows>] [--mode <braille\|block>] [--threshold <percent>] [--invert] |
— | Transcode an image into ASCII/Unicode art text |
tui¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy tui install |
omarchy-tui-install |
[name command window-style icon-url-or-name] |
— | Create a desktop launcher for a terminal UI app |
omarchy tui remove |
omarchy-tui-remove |
[name] |
— | Remove a terminal UI desktop launcher |
omarchy tui remove all |
omarchy-tui-remove-all |
— | — | Remove all TUIs installed via omarchy-tui-install. |
update¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy update |
omarchy-update |
[-y] |
sudo | Update Omarchy and system packages |
omarchy update analyze logs |
omarchy-update-analyze-logs |
— | — | Check the update log for known failure conditions |
omarchy update aur pkgs |
omarchy-update-aur-pkgs |
— | — | Update AUR packages if any are installed |
omarchy update available |
omarchy-update-available |
— | — | Check whether Omarchy updates are available. |
omarchy update confirm |
omarchy-update-confirm |
— | — | Prompt for confirmation before starting an update |
omarchy update dev |
omarchy-update-dev |
— | — | Update the active Omarchy dev checkout |
omarchy update firmware |
omarchy-update-firmware |
— | sudo | Update system firmware using fwupd. Ensures the fwupd EFI binary is installed |
omarchy update keyring |
omarchy-update-keyring |
— | sudo | Ensure the Omarchy and Arch keyring packages are installed and populated |
omarchy update lock |
omarchy-update-lock |
<held\|run> [command] [args...] |
hidden | Run a command while holding the Omarchy update lock |
omarchy update mise |
omarchy-update-mise |
— | — | Update mise-managed tools |
omarchy update orphan pkgs |
omarchy-update-orphan-pkgs |
— | sudo | Review and optionally remove orphaned system packages after updates |
omarchy update pacman guard |
omarchy-update-pacman-guard |
— | hidden | Prevent direct pacman system upgrades from bypassing omarchy update. |
omarchy update pkg prune |
omarchy-update-pkg-prune |
— | sudo | Prune superseded versions from the pacman package cache |
omarchy update requires free space |
omarchy-update-requires-free-space |
— | hidden | Check free disk space required for an update |
omarchy update restart |
omarchy-update-restart |
— | — | Prompt for required reboot or service restarts after updates |
omarchy update status |
omarchy-update-status |
— | hidden | Refresh the shell update status |
omarchy update stay awake |
omarchy-update-stay-awake |
<start\|stop> |
hidden | Manage sleep and idle inhibition during an update |
omarchy update system pkgs |
omarchy-update-system-pkgs |
— | sudo | Update system packages with pacman |
omarchy update system pkgs when conflicted |
omarchy-update-system-pkgs-when-conflicted |
— | hidden | Retry a system package update that hit a conflict |
omarchy update time |
omarchy-update-time |
— | sudo | Restart system time synchronization |
omarchy update user notify |
omarchy-update-user-notify |
— | hidden | Compatibility wrapper for omarchy-migrate-notify. |
upgrade¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy upgrade to quattro |
omarchy-upgrade-to-quattro |
[--yes] [--reboot] [--dev] [--channel stable\|rc\|edge] [--user USER] |
sudo | Upgrade a legacy Omarchy install to the package-backed Omarchy quattro layout. |
upload¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy upload log |
omarchy-upload-log |
<log-file> |
hidden | Upload logs to logs.omarchy.org |
version¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy version |
omarchy-version |
— | — | Print the installed Omarchy version |
omarchy version branch |
omarchy-version-branch |
— | hidden | Print the active Omarchy dev-link git branch |
omarchy version channel |
omarchy-version-channel |
— | — | Print the active Omarchy mirror and package channel |
omarchy version pkgs |
omarchy-version-pkgs |
— | — | Print when system packages were last upgraded |
voxtype¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy voxtype config |
omarchy-voxtype-config |
— | — | Open Voxtype configuration |
omarchy voxtype install |
omarchy-voxtype-install |
— | sudo | Install and configure Voxtype dictation |
omarchy voxtype model |
omarchy-voxtype-model |
— | — | Open Voxtype AI model setup |
omarchy voxtype remove |
omarchy-voxtype-remove |
— | sudo | Remove Voxtype dictation and its configuration |
omarchy voxtype status |
omarchy-voxtype-status |
— | — | Stream voxtype --follow status as bar-friendly JSON |
weather¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy weather icon |
omarchy-weather-icon |
— | — | Returns a weather condition icon, adjusted for live sunrise and sunset. |
omarchy weather location |
omarchy-weather-location |
— | — | Show or set the location used for weather reports |
omarchy weather status |
omarchy-weather-status |
— | — | Returns a formatted weather status string with temperature and wind speed. |
webapp¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy webapp handler hey |
omarchy-webapp-handler-hey |
[url] |
— | Open HEY webmail and translate mailto links |
omarchy webapp handler zoom |
omarchy-webapp-handler-zoom |
[url] |
— | Open Zoom web meetings from browser protocol links |
omarchy webapp install |
omarchy-webapp-install |
[name url icon-url-or-name [custom-exec] [mime-types]] |
— | Create a desktop launcher for a web app |
omarchy webapp remove |
omarchy-webapp-remove |
[name] |
— | Remove a web app desktop launcher |
omarchy webapp remove all |
omarchy-webapp-remove-all |
— | — | Remove all web apps installed via omarchy-webapp-install. |
windows¶
| 路由 | Binary | 参数 | 标记 | 摘要 / alias |
|---|---|---|---|---|
omarchy windows key |
omarchy-windows-key |
— | sudo | Print the OEM Windows product key stored in firmware |
omarchy windows vm |
omarchy-windows-vm |
<install\|remove\|launch\|stop\|status> [options] |
sudo | Install, launch, stop, inspect, or remove the Windows VM |
再生成¶
生成器会拒绝缺少 bin/ 的输入。提交前应再运行上游 omarchy commands --check，因为本页只复现展示所需字段，不替代 router 自身的 collision/metadata lint。