CLI

The Push To Display CLI lets you send updates and manage boards from your terminal. It's a single npm package that works on macOS, Linux, and Windows.

Install

You can run it directly with npx (no install needed):

npx pushtodisplay --help

Or install it globally:

npm install -g pushtodisplay

Log in

Before sending updates, authenticate with one of these methods:

API key

pushtodisplay auth login --api-key pt_your_api_key_here

Browser (OAuth)

pushtodisplay auth login

This opens your browser. Sign in with your Push To Display account and the CLI receives your credentials automatically.

Device code (headless)

For machines without a browser — SSH sessions, containers, or remote servers:

pushtodisplay auth login --device-code

The CLI prints a URL and a one-time code. Open the URL on any device, enter the code, and approve the login.

Send your first update

pushtodisplay send -b <board-id> "Hello from the CLI!"

That's it. The text appears on every device connected to the board.

JSON output

Add --json to any command to get machine-readable JSON output:

pushtodisplay boards list --json

This is useful when piping CLI output into other tools or scripts.

Check auth status

pushtodisplay auth status

Log out

pushtodisplay auth logout

Commands at a glance

Next

• Sending updates — all the ways to send content and style it
• Managing resources — boards and device commands