Documentation

Bring your Stream Deck buttons, dials, displays, and network Key Lights into Omarchy Shell. Start with installation, then shape your controls around the way you work.

Start here

1. Getting started — requirements, installation, user files, updates, and compatibility.
2. Using your controls — buttons, pages, folders, custom artwork, dials, and state icons.
3. Action packs — add your own commands and status-aware actions.

Get help

Open troubleshooting for runtime setup, USB access, light discovery, and diagnostics.

Hardware support varies by model. Read compatibility and limitations before relying on a particular feature.

Build on it

The plugin development guide covers builds, local installation, tests, and release validation. Plugin source remains on the repository’s main branch.

About these guides

These guides are the home for detailed Omarchy plugin documentation. The plugin README provides a short installation, update, and removal reference. Website development uses a separate Astro project on the site branch. Command examples that use bin/omarchy-elgato run from the installed plugin directory or a plugin source checkout.