The Screenly CLI simplifies interactions with Screenly through your terminal, designed for both manual use and task automation.

Download the latest release here.

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

$ nix-shell -p screenly-cli

For other operating systems or Docker usage:

$ docker run --rm \
    -e API_TOKEN=YOUR_API_TOKEN \
    screenly/cli:latest help

To build the Screenly CLI from source, ensure you have Rust installed:

$ cargo build --release

The screenly binary will be located in target/release.

To configure a non-production API server, set the API_SERVER_NAME environment variable:

$ API_SERVER_NAME=local cargo build --release

Explore available commands here.

Integrate Screenly CLI into your GitHub workflows:

Required Screenly API token for your team.

Required Command to execute (e.g., screen list).

Optional CLI version override.

uses: screenly/cli@master
with:
  screenly_api_token: ${{ secrets.SCREENLY_API_TOKEN }}
  cli_commands: screen list

Generate pb_signature.rs from signature.proto:

$ cargo install protobuf-codegen
$ protoc --rust_out . signature.proto
$ mv signature.rs src/pb_signature.rs

• Merge PRs into master.
• Update version in Cargo.toml, action.yml, Dockerfile, and GitHub Actions configurations.
• Create release branch (e.g., release-1.0.0) and tag (e.g., v1.0.0).
• Update Homebrew repo with the latest version.