Install the CLI

Homebrew, Nix, Docker, a release binary, or from source. Then sign in.

Copy page

View as Markdown View this page as plain text Open in Claude Ask questions about this page Open in ChatGPT Ask questions about this page

The CLI is open source and ships as a single binary.

Homebrew, on macOS

brew tap screenly/screenly-cli
brew install screenly-cli

Other routes

A release binary for your platform, from the latest release.

Nix and Docker are both supported; the README has the invocations.

From source with cargo build --release, if you already have a Rust toolchain.

macOS release artifacts are not yet Developer ID signed, so a browser download can be blocked by Gatekeeper. If that happens, allow it under System Settings, Privacy & Security, Open Anyway.

Signing in

screenly login

It takes an API token and stores it in ~/.screenly for subsequent commands. screenly logout removes it.

The API_TOKEN environment variable overrides the stored token, which is how you authenticate in CI without a login step.

Versions

The CLI moved to calendar versioning at 26.8.0, having previously been on 1.x. A version like 26.8.0 is the year and month it was released, not a semantic version, so a jump in the number does not imply a breaking change.