README
¶
Oriel
A fast, local, single-binary web GUI for Colima & Docker.
Manage containers, images, volumes, networks and Compose stacks from a clean,
themeable browser UI. ~15–30 MB RAM, zero dependencies, binds to 127.0.0.1.
Install
Quick install — detects your platform, verifies the checksum, installs to your PATH:
curl -fsSL https://raw.githubusercontent.com/ParadoxInfinite/oriel/main/install.sh | sh
[!CAUTION] This pipes a script into your shell, which runs as you. Read
install.shfirst — or use the explicit per-platform commands below, which do the same thing, one intentional step at a time.
Manual — copy the one-liner for your platform:
macOS · Apple Silicon (M1+)
curl -fL https://github.com/ParadoxInfinite/oriel/releases/latest/download/oriel-darwin-arm64 -o oriel && chmod +x oriel
macOS · Intel
curl -fL https://github.com/ParadoxInfinite/oriel/releases/latest/download/oriel-darwin-amd64 -o oriel && chmod +x oriel
Linux · arm64
curl -fL https://github.com/ParadoxInfinite/oriel/releases/latest/download/oriel-linux-arm64 -o oriel && chmod +x oriel
Linux · amd64
curl -fL https://github.com/ParadoxInfinite/oriel/releases/latest/download/oriel-linux-amd64 -o oriel && chmod +x oriel
Or with Go:
go install github.com/ParadoxInfinite/oriel@latest
Or from source: make build (builds the UI, embeds it, produces ./oriel).
Run
./oriel # opens http://127.0.0.1:4321
Flags: --port <n> (default 4321), --no-open. To run on login as a background service:
./oriel service install # launchd (macOS) / systemd (Linux); also: status, uninstall
Needs a Docker Engine–compatible runtime + the docker CLI. Colima
is first-class (adds VM start/stop); Docker Engine, OrbStack, Rancher/Docker Desktop,
Podman, and remote daemons also work — see docs/DAEMONS.md.
Features
- Containers — live CPU/mem, exit codes, bulk actions, streaming logs, full inspect.
- Images — pull with registry search, prune, digest-pinned naming, one-click tag.
- Compose — manage running stacks, plus discover & deploy projects from disk.
- Reclaim space — selectable prune as cancelable background jobs that survive a refresh.
- Dashboard — CPU history, memory, disk, and uptime/outage tracking.
- Command palette (
⌘K) — fuzzy-run any action; optional natural-language mode. - Editions & themes — swap the whole UI (Studio / Classic), light/dark/system, custom accents.
- Live — everything streams over one SSE connection; the UI never polls.
- Self-update — service installs update in-app via checksum-verified downloads.
Editions & themes
The presentation is a swappable plugin on a stable platform SDK. Ships with Studio (default; light/dark/system) and Classic (dark teal); recolor either, or drop in your own. See docs/THEMES.md.
Security
Oriel has no authentication, and driving Docker is effectively root on the host. Run it locally, or reach it remotely over a private network only (Tailscale, ZeroTier, WireGuard, …). Never put it on the public internet. Full trust model: SECURITY.md.
More
- Reverse-proxy subpath:
ORIEL_BASE_PATH=/oriel ./oriel— one build serves root or a subpath. - Natural-language control: point
ORIEL_PROVIDER_URLat a resolver; suggestions run through the same validated tool path, and the base binary links no ML code. - Develop:
make dev+make dev-web(Vite hot reload),make test. See CONTRIBUTING.md.
License
Apache-2.0 © The Oriel contributors. See NOTICE.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
actions
Package actions wires concrete Docker/Colima operations into the generic tool Registry and supplies the entity resolver.
|
Package actions wires concrete Docker/Colima operations into the generic tool Registry and supplies the entity resolver. |
|
colima
Package colima wraps the `colima` CLI, which has no API.
|
Package colima wraps the `colima` CLI, which has no API. |
|
discovery
Package discovery finds Docker Compose projects on disk under user-configured roots, so the UI can offer "available but not yet deployed" stacks alongside the label-derived running ones.
|
Package discovery finds Docker Compose projects on disk under user-configured roots, so the UI can offer "available but not yet deployed" stacks alongside the label-derived running ones. |
|
docker
Package docker talks to the Docker Engine API exposed by Colima's unix socket.
|
Package docker talks to the Docker Engine API exposed by Colima's unix socket. |
|
execstream
Package execstream runs a command and streams its combined output line by line, used for long-running CLI operations (colima lifecycle, docker compose) that the UI displays as live progress.
|
Package execstream runs a command and streams its combined output line by line, used for long-running CLI operations (colima lifecycle, docker compose) that the UI displays as live progress. |
|
provider
Package provider is the dormant extension seam for natural-language actions.
|
Package provider is the dormant extension seam for natural-language actions. |
|
server
Package server wires the HTTP router for Oriel: a small JSON REST surface for actions, SSE channels for live data, and the embedded frontend.
|
Package server wires the HTTP router for Oriel: a small JSON REST surface for actions, SSE channels for live data, and the embedded frontend. |
|
service
Package service installs Oriel as a background service so it starts automatically and stays running: a launchd LaunchAgent on macOS, and a systemd service on Linux (a per-user unit, or a system unit with --system / when run as root).
|
Package service installs Oriel as a background service so it starts automatically and stays running: a launchd LaunchAgent on macOS, and a systemd service on Linux (a per-user unit, or a system unit with --system / when run as root). |
|
tools
Package tools is the canonical action layer.
|
Package tools is the canonical action layer. |