David Heinemeier HanssonandClaude Fable 5
55434792d1
Add chapters for the top bar and its panels, screenshots and recording, toggles/idle/screensaver, browsers, shell plugins, and networking, which collects the Wi-Fi, DNS, firewall, and Tailscale material that was spread across the FAQ, TUIs, and services chapters. Fill smaller gaps in the existing chapters: user hooks, autostart, menu extensions, printing, power profiles, factory reset, drive and user passwords, passwordless sudo, firmware updates, display text size, and the LocalSend share menu. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
63 lines
3.8 KiB
Markdown
63 lines
3.8 KiB
Markdown
# Omarchy CLI
|
||
|
||
Omarchy is usually controlled through the hotkeys and the Omarchy menu (`Super + Space`). But you can also control it through the `omarchy` CLI. This is particularly helpful when you're having an AI agent work with you on customization or configuration.
|
||
|
||
The CLI has access to all the internal tooling that is used both via the menu and otherwise. You can see everything that's available by running `omarchy` in the terminal.
|
||
|
||
It looks something like this:
|
||
|
||
```
|
||
~ ❯ omarchy
|
||
Omarchy command center
|
||
|
||
Usage:
|
||
omarchy <command> [args...]
|
||
omarchy commands [--all] [--json] [--check]
|
||
omarchy <group> --help
|
||
omarchy <group> <command> --help
|
||
|
||
Common commands:
|
||
omarchy update Update Omarchy and system packages
|
||
omarchy theme list List available themes
|
||
omarchy theme set <name> Apply a theme
|
||
omarchy font list List available fonts
|
||
omarchy screenshot Take a screenshot
|
||
omarchy debug Print debugging information
|
||
|
||
Groups:
|
||
agent AI coding agent usage data
|
||
audio Audio input and output controls
|
||
bar Omarchy shell bar layout and settings
|
||
battery Battery status helpers
|
||
bluetooth Bluetooth device controls
|
||
branch Omarchy git branch management
|
||
branding About and screensaver branding
|
||
brightness Display and keyboard brightness
|
||
capture Screenshots and screen recording
|
||
channel Omarchy release channel management
|
||
clipboard Clipboard helpers
|
||
cmd Command and shortcut helpers
|
||
config System configuration helpers
|
||
debug Diagnostics and support logs
|
||
...
|
||
```
|
||
|
||
And you can dive deeper on every group:
|
||
|
||
```
|
||
~ ❯ omarchy capture
|
||
Capture commands — Screenshots and screen recording:
|
||
omarchy capture qr Decode a QR code from a screenshot region
|
||
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
|
||
omarchy capture screenrecording with webcam Pick a webcam and start a screen recording with it
|
||
omarchy capture screenshot [smart|region|windows|fullscreen] [slurp|copy|save] [--editor=<name>] Take a screenshot
|
||
omarchy capture text Extract text from a screenshot region with OCR
|
||
omarchy capture webcam resize <smaller|larger|reset|small|medium|large> Resize the active webcam recording overlay
|
||
```
|
||
|
||
Every command takes `--help` too, whether you ask a whole group (`omarchy capture --help`) or a single command (`omarchy capture screenshot --help`).
|
||
|
||
### Opening the menu from the terminal
|
||
|
||
The Omarchy menu is scriptable as well, which is handy for your own keybindings. `omarchy menu` opens it at the root, and you can jump straight to any point in the tree by naming it: `omarchy menu summon style.theme` goes right to the theme picker, `omarchy menu toggle system` opens the system menu and closes it again if it's already up, and `omarchy menu close` puts it away.
|