Trillboards
Back to Developers
Developer Docs

CLI Tool.

The most powerful developer tool in out-of-home advertising

Terminal
$ npx @trillboards/cli

Overview

The Trillboards CLI is a terminal-first developer tool that puts your entire DOOH fleet at your fingertips. Monitor screens in real time, debug ad serving issues, tail revenue as it flows, and manage test environments — all without leaving your terminal.

  • Real-time fleet dashboard with live screen status updates
  • Revenue ticker that streams earnings as impressions complete
  • Full screen diagnostics — heartbeat, fill rate, error logs, audience data
  • Webhook forwarding to localhost for local development
  • Ad auction replay to debug waterfall decisions
  • Test sandbox environments with isolated screen pools
  • Raw API escape hatch for any endpoint

Commands

Fleet Management

$ trillboards screens watch

Live fleet dashboard with screen status, fill rates, and health

$ trillboards screens list

List all screens with status, last heartbeat, and partner

$ trillboards debug <screen>

Full diagnostic dump — heartbeat, errors, fill rate, audience

$ trillboards doctor

System health check — API connectivity, auth, screen count

Revenue & Analytics

$ trillboards earnings live

Real-time revenue ticker streaming as impressions complete

$ trillboards fill-rate --by partner

Fill rate analysis grouped by partner, screen, or time

$ trillboards audience live <screen>

Real-time audience sensing data — face count, attention, dwell

Debugging

$ trillboards logs tail

Stream API request logs with filtering and search

$ trillboards waterfall <req>

Replay an ad auction to see partner decisions and timing

$ trillboards errors <code>

Look up any error code with cause, fix, and docs link

$ trillboards listen <port>

Forward webhooks to localhost for local development

Environment

$ trillboards sandbox create

Create an isolated test environment with mock screens

$ trillboards api GET /v1/...

Raw API escape hatch — any method, any endpoint

Example Session

A typical debugging workflow with the CLI.

Terminal
$ trillboards doctor
  API         https://api.trillboards.com   200 OK    42ms
  Auth        trb_partner_a1b2c3...         valid
  Screens     147 online, 3 offline
  Fill rate   82.4% (last 1h)
  Revenue     $127.50 today

$ trillboards debug scr_abc123
  Screen      Lobby Display (scr_abc123)
  Status      online
  Heartbeat   2s ago
  Fill rate   91.2%
  Audience    4 viewers, 0.78 attention score
  Last error  none (24h)
  Partner     *** (variant_a)

$ trillboards earnings live
  09:41:12  +$0.0037  scr_abc123  variant_a  play_completed
  09:41:14  +$0.0042  scr_def456  variant_b  play_completed
  09:41:15  +$0.0029  scr_abc123  variant_a  play_completed
  ...streaming (Ctrl+C to stop)

$ trillboards waterfall req_xyz789
  1. variant_a   bid_received   $3.20 CPM   142ms
  2. variant_b   no_bid         -           89ms
  3. variant_c   timeout        -           2001ms
  Winner: variant_a ($3.20 CPM)

Getting Started

Install

No global install required. Run directly with npx.

Terminal
$ npx @trillboards/cli

Login

Authenticate with your partner API key.

Terminal
$ trillboards login
  Enter your API key: trb_partner_***
  Authenticated as Acme Vending
  API key saved to ~/.trillboards/credentials

Try it

Watch your fleet in real time.

Terminal
$ trillboards screens watch
  NAME              STATUS    FILL    LAST HEARTBEAT    VIEWERS
  Lobby Display     online    91.2%   2s ago            4
  Break Room TV     online    78.6%   5s ago            1
  Entrance Kiosk    offline   -       2h ago            -
  ...watching (Ctrl+C to stop)

Need Help?

Contact our developer support at developers@trillboards.com or visit the Support page.

Your fleet, in your terminal.

One command to install. Zero config. All the power.

View Full CLI ReferenceBack to Developers