Run is a CLI for self-hosting anything on your own machine, Omni products and third-party apps alike. One command brings up a full stack with automatic SSL, reverse proxy, secrets, and health checks.
Full documentation lives at docs.omni.dev/products/run.
| Platform | Channel | Command / Link |
|---|---|---|
| All | GitHub Releases | Download from the releases page |
| macOS / Linux | Shell | curl -fsSL https://run.omni.dev/install.sh | sh |
| macOS / Linux | Homebrew | brew install omnidotdev/tap/run-cli |
| Arch Linux | AUR / AUR (bin) | paru -S omnidotdev-run-cli or paru -S omnidotdev-run-cli-bin |
| Any | Source | cargo build --release (binary at target/release/run) |
- Docker with the Compose plugin
- mkcert, optional, for trusted local HTTPS (without it, Run serves over HTTP)
# a catalog app (Omni or third-party)
run up runa
run up uptime-kuma
# or bring your own: a compose project, a recipe, or any image
run up . # a directory holding a compose file or run.toml
run up ./docker-compose.yml # an explicit compose file
run up nginx # a bare image referenceEach command takes a target: a catalog name, a path to a recipe (run.toml / run.yaml) or a docker-compose file (or a directory holding one), or a bare image reference.
| Command | Description |
|---|---|
run up <target> |
Start a stack (run <target> is shorthand) |
run down <target> |
Stop a stack; --fresh wipes data (auto-snapshots first unless --no-backup) |
run ls |
List catalog apps |
run plan <target> |
Preview what would start, without changes |
run logs <target> [service] |
Tail container logs |
run backup <target> / run backups <target> |
Snapshot volumes / list snapshots |
run restore <target> <snapshot> |
Restore volumes from a snapshot |
run status [target] |
Show a stack's services, or list every stack |
run update <target> |
Pull the latest images and recreate; auto-rollback on failure |
run deploy <target> |
Emit a fractal.yaml to deploy the stack to Fractal cloud |
Diagnose a stack with run plan <target> (a dry-run preview) and run logs <target>. Recipes, magic tokens, typed inputs, backups, and the built-in catalog are documented at docs.omni.dev/products/run.
cargo build # build
cargo test --workspace # run the tests
cargo clippy --all-targets -- -D warnings # lint
cargo fmt --all # format
cargo run -p run-cli -- plan runa # run the CLI locallyThe crate version is driven by package.json (Changesets); scripts/syncVersion.ts propagates it to the Cargo manifests, so edit the version through a changeset rather than by hand. A pre-commit hook runs fmt, clippy, and the tests.
The code in this repository is licensed under Apache 2.0, © Omni LLC. See LICENSE.md for more information.