OmarOS CLI¶

OmarOS is usually controlled through the hotkeys and the OmarOS menu (Super + Space). But you can also control it through the omaros 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 omaros in the terminal.

It looks something like this:

~ ❯ omaros
OmarOS command center

Usage:
  omaros <command> [args...]
  omaros commands [--all] [--json] [--check]
  omaros <group> --help
  omaros <group> <command> --help

Common commands:
  omaros update              Update OmarOS and system packages
  omaros theme list          List available themes
  omaros theme set <name>    Apply a theme
  omaros font list           List available fonts
  omaros screenshot          Take a screenshot
  omaros debug               Print debugging information

Groups:
  audio          Audio input and output controls
  bar            OmarOS shell bar layout and settings
  battery        Battery status helpers
  bluetooth      Bluetooth device controls
  branch         OmarOS git branch management
  branding       About and screensaver branding
  brightness     Display and keyboard brightness
  capture        Screenshots and screen recording
  channel        OmarOS 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:

~ ❯ omaros capture
Capture commands — Screenshots and screen recording:
  omaros capture qr                                                                                                                                                                                                       Decode a QR code from a screenshot region
  omaros 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
  omaros capture screenrecording with webcam                                                                                                                                                                              Pick a webcam and start a screen recording with it
  omaros capture screenshot [smart|region|windows|fullscreen|scroll] [copy|save]                                                                                                                                          Take a screenshot
  omaros capture text                                                                                                                                                                                                     Extract text from a screenshot region with OCR
  omaros 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 (omaros capture --help) or a single command (omaros capture screenshot --help).

The OmarOS menu is scriptable as well, which is handy for your own keybindings. omaros menu opens it at the root, and you can jump straight to any point in the tree by naming it: omaros menu summon style.theme goes right to the theme picker, omaros menu toggle system opens the system menu and closes it again if it's already up, and omaros menu close puts it away.

OmarOS CLI¶

Opening the menu from the terminal¶