@trillboards/cli
v0.1.1
Published
Official CLI for the Trillboards DOOH API
Downloads
22
Readme
trillboards-cli
A new CLI generated with oclif
Usage
$ npm install -g @trillboards/cli
$ trillboards COMMAND
running command...
$ trillboards (--version)
@trillboards/cli/0.1.1 darwin-arm64 node-v22.22.0
$ trillboards --help [COMMAND]
USAGE
$ trillboards COMMAND
...Commands
trillboards ads disabletrillboards ads enabletrillboards ads logintrillboards ads starttrillboards api METHOD PATHtrillboards audience live SCREEN_IDtrillboards autocomplete [SHELL]trillboards billingtrillboards billing usagetrillboards codetrillboards debug SCREEN_IDtrillboards devices reconcile FILEtrillboards doctortrillboards earnings [MODE]trillboards endpointstrillboards errors [CODE]trillboards fill-ratetrillboards generated generated-changelog-querytrillboards generated generated-data-api-aggregatetrillboards generated generated-data-api-list-screenstrillboards generated generated-data-api-lookalike-screenstrillboards generated generated-data-api-query-dsltrillboards generated generated-data-api-screen-audience-history SCREENIDtrillboards generated generated-data-api-screen-audience-live SCREENIDtrillboards generated generated-data-api-semantic-searchtrillboards generated generated-data-api-statstrillboards generated generated-data-api-streamtrillboards generated generated-data-api-usagetrillboards generated generated-device-heartbeat-get DEVICEIDtrillboards generated generated-device-ota-manifesttrillboards generated generated-example-healthchecktrillboards generated generated-federated-get-latest-model-descriptor MODELTYPEtrillboards generated generated-federated-get-model-weights MODELTYPEtrillboards generated generated-federated-gradient-uploadtrillboards generated generated-federated-performance-uploadtrillboards generated generated-federated-taste-uploadtrillboards generated generated-playground-dry-run OPERATION_IDtrillboards generated generated-post-device-heartbeat DEVICEIDtrillboards generated generated-request-metadata-get REQUEST_IDtrillboards generated generated-sdk-enrichtrillboards generated generated-sdk-impressiontrillboards generated generated-sdk-qr-beacontrillboards generated generated-sdk-qr-scantrillboards generated generated-sensing-paired-training-uploadtrillboards help [COMMAND]trillboards listen PORTtrillboards logintrillboards logs tailtrillboards reconciletrillboards sandbox createtrillboards sandbox emit EVENT_TYPEtrillboards sandbox resettrillboards sandbox statustrillboards screens watchtrillboards trigger [EVENT_TYPE]trillboards validate FILEtrillboards whoami
trillboards ads disable
Turn off the in-place sponsored lines (removes the Claude Code dead-time hook).
USAGE
$ trillboards ads disable [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Turn off the in-place sponsored lines (removes the Claude Code dead-time hook).
EXAMPLES
$ trillboards ads disableSee code: src/commands/ads/disable.ts
trillboards ads enable
Turn on in-place sponsored lines in Claude Code (installs the dead-time hook). Opt-in; undo with ads disable.
USAGE
$ trillboards ads enable [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Turn on in-place sponsored lines in Claude Code (installs the dead-time hook). Opt-in; undo with `ads disable`.
EXAMPLES
$ trillboards ads enableSee code: src/commands/ads/enable.ts
trillboards ads login
Log in to the agent-ads program with your Trillboards account (email + password)
USAGE
$ trillboards ads login [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--email <value>]
[--password <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--email=<value> Account email (prompts if omitted)
--format=<option> Output format
<options: json|table|yaml>
--password=<value> Account password (prompts hidden if omitted; avoid passing on the command line)
DESCRIPTION
Log in to the agent-ads program with your Trillboards account (email + password)
EXAMPLES
$ trillboards ads login
$ trillboards ads login --email [email protected]
TRILLBOARDS_USER_TOKEN=<jwt> trillboards ads loginSee code: src/commands/ads/login.ts
trillboards ads start
Register this machine as a virtual screen and rent its AI-coding-agent dead-time for money
USAGE
$ trillboards ads start [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--name <value>]
[--once] [--simulate] [--interval <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--interval=<value> Seconds between dead-time fills in --simulate mode (default 60)
--name=<value> Display name for this virtual screen (defaults to "Claude Code on <hostname>")
--once Register, heartbeat once, serve a single ad, then exit (great for testing)
--simulate Treat each interval tick as a dead-time trigger (v0 stand-in for real detection)
DESCRIPTION
Register this machine as a virtual screen and rent its AI-coding-agent dead-time for money
EXAMPLES
$ trillboards ads start
$ trillboards ads start --once
$ trillboards ads start --simulate --interval 30See code: src/commands/ads/start.ts
trillboards api METHOD PATH
Make raw API requests (like gh api)
USAGE
$ trillboards api METHOD PATH [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [-d
<value>] [--jq <value>]
ARGUMENTS
METHOD HTTP method (GET, POST, PUT, PATCH, DELETE)
PATH API path (e.g. /v1/partner/screens)
FLAGS
-d, --data=<value> Request body (JSON string)
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--jq=<value> JSON path expression to extract (e.g. "data.items" or "name")
DESCRIPTION
Make raw API requests (like gh api)
EXAMPLES
$ trillboards api GET /v1/partner/screens
$ trillboards api POST /v1/partner/device --data '{"name":"test"}'
$ trillboards api GET /v1/partner/info --jq partner_nameSee code: src/commands/api.ts
trillboards audience live SCREEN_ID
Real-time audience sensing data for a screen
USAGE
$ trillboards audience live SCREEN_ID [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
[--interval <value>]
ARGUMENTS
SCREEN_ID Screen ID to monitor
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--interval=<value> [default: 5] Polling interval in seconds
DESCRIPTION
Real-time audience sensing data for a screen
EXAMPLES
$ trillboards audience live scr_abc123
$ trillboards audience live scr_abc123 --format json
$ trillboards audience live scr_abc123 --interval 3See code: src/commands/audience/live.ts
trillboards autocomplete [SHELL]
Display autocomplete installation instructions.
USAGE
$ trillboards autocomplete [SHELL] [-r]
ARGUMENTS
[SHELL] (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ trillboards autocomplete
$ trillboards autocomplete bash
$ trillboards autocomplete zsh
$ trillboards autocomplete powershell
$ trillboards autocomplete --refresh-cacheSee code: @oclif/plugin-autocomplete
trillboards billing
Billing summary — current plan and usage
USAGE
$ trillboards billing [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Billing summary — current plan and usage
EXAMPLES
$ trillboards billing
$ trillboards billing --format jsonSee code: src/commands/billing.ts
trillboards billing usage
Billing usage details with optional per-product breakdown
USAGE
$ trillboards billing usage [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--breakdown]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--breakdown Show per-product breakdown table
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Billing usage details with optional per-product breakdown
EXAMPLES
$ trillboards billing usage
$ trillboards billing usage --breakdown
$ trillboards billing usage --format jsonSee code: src/commands/billing/usage.ts
trillboards code
Wrap your coding agent and earn from its dead-time (plays text/image/video ads while it thinks)
USAGE
$ trillboards code [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Wrap your coding agent and earn from its dead-time (plays text/image/video ads while it thinks)
EXAMPLES
$ trillboards code
$ trillboards code claude
$ trillboards code -- codex --fooSee code: src/commands/code.ts
trillboards debug SCREEN_ID
Diagnose a screen — status, performance, audience, issues
USAGE
$ trillboards debug SCREEN_ID [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
ARGUMENTS
SCREEN_ID Screen ID to diagnose
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Diagnose a screen — status, performance, audience, issues
EXAMPLES
$ trillboards debug scr_abc123
$ trillboards debug scr_abc123 --format jsonSee code: src/commands/debug.ts
trillboards devices reconcile FILE
Reconcile your device fleet — diff your external IDs against what Trillboards has registered (matched / missing / orphan / malformed / duplicate)
USAGE
$ trillboards devices reconcile FILE [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
ARGUMENTS
FILE Path to your device external IDs — a JSON array, {"external_ids":[...]}, or one ID per line
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Reconcile your device fleet — diff your external IDs against what Trillboards has registered (matched / missing /
orphan / malformed / duplicate)
EXAMPLES
$ trillboards devices reconcile my-devices.json
$ trillboards devices reconcile ids.txt --format jsonSee code: src/commands/devices/reconcile.ts
trillboards doctor
Run system diagnostics and check API connectivity
USAGE
$ trillboards doctor [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Run system diagnostics and check API connectivity
EXAMPLES
$ trillboards doctorSee code: src/commands/doctor.ts
trillboards earnings [MODE]
Revenue dashboard — today's summary, historical charts, or live streaming
USAGE
$ trillboards earnings [MODE] [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--period
<value>]
ARGUMENTS
[MODE] (live) Mode: "live" for real-time streaming
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--period=<value> [default: 1d] Time period (e.g. 1d, 7d, 30d)
DESCRIPTION
Revenue dashboard — today's summary, historical charts, or live streaming
EXAMPLES
$ trillboards earnings
$ trillboards earnings --period 30d
$ trillboards earnings live
$ trillboards earnings --format jsonSee code: src/commands/earnings.ts
trillboards endpoints
Discover available API endpoints
USAGE
$ trillboards endpoints [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [-s <value>]
FLAGS
-s, --search=<value> Search query to filter endpoints
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Discover available API endpoints
EXAMPLES
$ trillboards endpoints
$ trillboards endpoints --search screens
$ trillboards endpoints --format jsonSee code: src/commands/endpoints/index.ts
trillboards errors [CODE]
Look up error codes from the error catalog
USAGE
$ trillboards errors [CODE] [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
ARGUMENTS
[CODE] Error code to look up (e.g. screen_not_found)
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Look up error codes from the error catalog
EXAMPLES
$ trillboards errors
$ trillboards errors screen_not_found
$ trillboards errors --format jsonSee code: src/commands/errors/index.ts
trillboards fill-rate
Fill rate analysis — overall, per-screen, or by time
USAGE
$ trillboards fill-rate [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--by
partner|screen|hour]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--by=<option> Breakdown dimension
<options: partner|screen|hour>
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Fill rate analysis — overall, per-screen, or by time
EXAMPLES
$ trillboards fill-rate
$ trillboards fill-rate --by screen
$ trillboards fill-rate --by hour
$ trillboards fill-rate --format jsonSee code: src/commands/fill-rate.ts
trillboards generated generated-changelog-query
Query API changelog
USAGE
$ trillboards generated generated-changelog-query [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--since <value>]
[--type <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--since=<value> Only entries dated on or after this date (YYYY-MM-DD). Unreleased entries always included.
--type=<value> Filter by change category: "breaking" (changed+removed), "additive" (added), "deprecation"
(deprecated), "fix" (fixed). Comma-separated for multiple.
DESCRIPTION
Query API changelog
EXAMPLES
$ trillboards generated changelog querySee code: src/commands/generated/generated-changelog-query.ts
trillboards generated generated-data-api-aggregate
Aggregate audience analytics for a time window.
USAGE
$ trillboards generated generated-data-api-aggregate [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--group_by
<value>] [--metric <value>] [--since <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--group_by=<value> Dimension to group aggregations by.
--metric=<value> Metric to aggregate on.
--since=<value> Relative time window (e.g. "24h", "7d").
DESCRIPTION
Aggregate audience analytics for a time window.
EXAMPLES
$ trillboards generated data-api-aggregateSee code: src/commands/generated/generated-data-api-aggregate.ts
trillboards generated generated-data-api-list-screens
List screens visible to the caller.
USAGE
$ trillboards generated generated-data-api-list-screens [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--limit <value>]
[--offset <value>] [--venue_type <value>] [--country <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--country=<value> ISO-3166 alpha-2 country code.
--format=<option> Output format
<options: json|table|yaml>
--limit=<value> limit
--offset=<value> offset
--venue_type=<value> Filter by venue taxonomy type (e.g. bar, restaurant).
DESCRIPTION
List screens visible to the caller.
EXAMPLES
$ trillboards generated data-api-list-screensSee code: src/commands/generated/generated-data-api-list-screens.ts
trillboards generated generated-data-api-lookalike-screens
Find screens with similar audience profiles.
USAGE
$ trillboards generated generated-data-api-lookalike-screens [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--screen_id
<value>] [--limit <value>] [--min_similarity <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--limit=<value> limit
--min_similarity=<value> min_similarity
--screen_id=<value> Internal screen identifier.
DESCRIPTION
Find screens with similar audience profiles.
EXAMPLES
$ trillboards generated data-api-lookalike-screensSee code: src/commands/generated/generated-data-api-lookalike-screens.ts
trillboards generated generated-data-api-query-dsl
Composable query DSL over approved datasets.
USAGE
$ trillboards generated generated-data-api-query-dsl [--api-key <value>] [--base-url <value>] [--format
json|table|yaml] [--data <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--data=<value> JSON request body
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Composable query DSL over approved datasets.
EXAMPLES
$ trillboards generated data-api-query-dslSee code: src/commands/generated/generated-data-api-query-dsl.ts
trillboards generated generated-data-api-screen-audience-history SCREENID
Historical audience_metrics rows for a screen.
USAGE
$ trillboards generated generated-data-api-screen-audience-history SCREENID [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--since
<value>] [--until <value>] [--limit <value>]
ARGUMENTS
SCREENID Internal screen identifier.
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--limit=<value> limit
--since=<value> ISO-8601 start timestamp.
--until=<value> ISO-8601 end timestamp.
DESCRIPTION
Historical audience_metrics rows for a screen.
EXAMPLES
$ trillboards generated data-api-screen-audience-historySee code: src/commands/generated/generated-data-api-screen-audience-history.ts
trillboards generated generated-data-api-screen-audience-live SCREENID
Real-time audience snapshot for a screen.
USAGE
$ trillboards generated generated-data-api-screen-audience-live SCREENID [--api-key <value>] [--base-url <value>]
[--format json|table|yaml]
ARGUMENTS
SCREENID Internal screen identifier.
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Real-time audience snapshot for a screen.
EXAMPLES
$ trillboards generated data-api-screen-audience-liveSee code: src/commands/generated/generated-data-api-screen-audience-live.ts
trillboards generated generated-data-api-semantic-search
Similarity search over scene embeddings.
USAGE
$ trillboards generated generated-data-api-semantic-search [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--q <value>]
[--limit <value>] [--since <value>] [--min_similarity <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--limit=<value> limit
--min_similarity=<value> min_similarity
--q=<value> q
--since=<value> Relative time window (e.g. "24h", "7d").
DESCRIPTION
Similarity search over scene embeddings.
EXAMPLES
$ trillboards generated data-api-semantic-searchSee code: src/commands/generated/generated-data-api-semantic-search.ts
trillboards generated generated-data-api-stats
Platform-wide counters.
USAGE
$ trillboards generated generated-data-api-stats [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Platform-wide counters.
EXAMPLES
$ trillboards generated data-api-statsSee code: src/commands/generated/generated-data-api-stats.ts
trillboards generated generated-data-api-stream
Server-Sent Events stream of live audience/observation events.
USAGE
$ trillboards generated generated-data-api-stream [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
[--observation_family <value>] [--venue_type <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--observation_family=<value> observation_family
--venue_type=<value> venue_type
DESCRIPTION
Server-Sent Events stream of live audience/observation events.
EXAMPLES
$ trillboards generated data-api-streamSee code: src/commands/generated/generated-data-api-stream.ts
trillboards generated generated-data-api-usage
API usage for the authenticated key (billing dashboard).
USAGE
$ trillboards generated generated-data-api-usage [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
[--days <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--days=<value> days
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
API usage for the authenticated key (billing dashboard).
EXAMPLES
$ trillboards generated data-api-usageSee code: src/commands/generated/generated-data-api-usage.ts
trillboards generated generated-device-heartbeat-get DEVICEID
Read live device heartbeat state.
USAGE
$ trillboards generated generated-device-heartbeat-get DEVICEID [--api-key <value>] [--base-url <value>] [--format
json|table|yaml]
ARGUMENTS
DEVICEID Device fingerprint or external device ID.
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Read live device heartbeat state.
EXAMPLES
$ trillboards generated device-heartbeat getSee code: src/commands/generated/generated-device-heartbeat-get.ts
trillboards generated generated-device-ota-manifest
Signed OTA manifest for managed-device update clients.
USAGE
$ trillboards generated generated-device-ota-manifest [--api-key <value>] [--base-url <value>] [--format
json|table|yaml] [--agent <value>]
FLAGS
--agent=<value> Optional agent type filter (`agent-core`, `agent-core-lite`, etc.). When omitted the caller
receives the default manifest bundle.
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Signed OTA manifest for managed-device update clients.
EXAMPLES
$ trillboards generated device-ota-manifestSee code: src/commands/generated/generated-device-ota-manifest.ts
trillboards generated generated-example-healthcheck
Example healthcheck (Phase 3 pipeline proof)
USAGE
$ trillboards generated generated-example-healthcheck [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--verbose
<value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--verbose=<value> When `true`, include diagnostic fields in the response.
DESCRIPTION
Example healthcheck (Phase 3 pipeline proof)
EXAMPLES
$ trillboards generated example-healthcheckSee code: src/commands/generated/generated-example-healthcheck.ts
trillboards generated generated-federated-get-latest-model-descriptor MODELTYPE
Fetch the latest aggregated model descriptor (download URL + sha256 + version).
USAGE
$ trillboards generated generated-federated-get-latest-model-descriptor MODELTYPE [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
[--venue_type <value>] [--venue_subtype <value>] [--daypart <value>] [--geo <value>] [--device_profile <value>]
ARGUMENTS
MODELTYPE Federated model name.
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--daypart=<value> daypart
--device_profile=<value> device_profile
--format=<option> Output format
<options: json|table|yaml>
--geo=<value> geo
--venue_subtype=<value> venue_subtype
--venue_type=<value> Venue category (required).
DESCRIPTION
Fetch the latest aggregated model descriptor (download URL + sha256 + version).
EXAMPLES
$ trillboards generated federated-get-latest-model-descriptorSee code: src/commands/generated/generated-federated-get-latest-model-descriptor.ts
trillboards generated generated-federated-get-model-weights MODELTYPE
Fetch aggregated weights for the device-specific slice.
USAGE
$ trillboards generated generated-federated-get-model-weights MODELTYPE [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
[--venue_type <value>] [--venue_subtype <value>] [--daypart <value>] [--geo <value>] [--device_profile <value>]
ARGUMENTS
MODELTYPE Federated model name.
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--daypart=<value> daypart
--device_profile=<value> device_profile
--format=<option> Output format
<options: json|table|yaml>
--geo=<value> geo
--venue_subtype=<value> venue_subtype
--venue_type=<value> Venue category for slice lookup. Snake_case query alias of venueType.
DESCRIPTION
Fetch aggregated weights for the device-specific slice.
EXAMPLES
$ trillboards generated federated-get-model-weightsSee code: src/commands/generated/generated-federated-get-model-weights.ts
trillboards generated generated-federated-gradient-upload
Upload sparsified gradients for multi-slice federated aggregation.
USAGE
$ trillboards generated generated-federated-gradient-upload [--api-key <value>] [--base-url <value>] [--format
json|table|yaml] [--data <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--data=<value> JSON request body
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Upload sparsified gradients for multi-slice federated aggregation.
EXAMPLES
$ trillboards generated federated-gradient-uploadSee code: src/commands/generated/generated-federated-gradient-upload.ts
trillboards generated generated-federated-performance-upload
Report on-device model performance metrics.
USAGE
$ trillboards generated generated-federated-performance-upload [--api-key <value>] [--base-url <value>] [--format
json|table|yaml] [--data <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--data=<value> JSON request body
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Report on-device model performance metrics.
EXAMPLES
$ trillboards generated federated-performance-uploadSee code: src/commands/generated/generated-federated-performance-upload.ts
trillboards generated generated-federated-taste-upload
Upload a screen-taste embedding for content personalization aggregation.
USAGE
$ trillboards generated generated-federated-taste-upload [--api-key <value>] [--base-url <value>] [--format
json|table|yaml] [--data <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--data=<value> JSON request body
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Upload a screen-taste embedding for content personalization aggregation.
EXAMPLES
$ trillboards generated federated-taste-uploadSee code: src/commands/generated/generated-federated-taste-upload.ts
trillboards generated generated-playground-dry-run OPERATION_ID
Dry-run validate a request body against an operation schema
USAGE
$ trillboards generated generated-playground-dry-run OPERATION_ID [--api-key <value>] [--base-url <value>] [--format
json|table|yaml]
ARGUMENTS
OPERATION_ID The operationId of the endpoint to validate against.
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Dry-run validate a request body against an operation schema
EXAMPLES
$ trillboards generated playground-dry-runSee code: src/commands/generated/generated-playground-dry-run.ts
trillboards generated generated-post-device-heartbeat DEVICEID
Submit a device heartbeat.
USAGE
$ trillboards generated generated-post-device-heartbeat DEVICEID [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--data
<value>]
ARGUMENTS
DEVICEID Device fingerprint or external device ID.
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--data=<value> JSON request body
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Submit a device heartbeat.
EXAMPLES
$ trillboards generated post-device-heartbeatSee code: src/commands/generated/generated-post-device-heartbeat.ts
trillboards generated generated-request-metadata-get REQUEST_ID
Look up metadata for a recent API request
USAGE
$ trillboards generated generated-request-metadata-get REQUEST_ID [--api-key <value>] [--base-url <value>] [--format
json|table|yaml]
ARGUMENTS
REQUEST_ID Server-generated request ID to look up.
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Look up metadata for a recent API request
EXAMPLES
$ trillboards generated request-metadata getSee code: src/commands/generated/generated-request-metadata-get.ts
trillboards generated generated-sdk-enrich
Census + demographic enrichment from the request IP.
USAGE
$ trillboards generated generated-sdk-enrich [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
[--data <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--data=<value> JSON request body
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Census + demographic enrichment from the request IP.
EXAMPLES
$ trillboards generated sdk-enrichSee code: src/commands/generated/generated-sdk-enrich.ts
trillboards generated generated-sdk-impression
Ingest an enriched CTV/DOOH impression.
USAGE
$ trillboards generated generated-sdk-impression [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
[--data <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--data=<value> JSON request body
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Ingest an enriched CTV/DOOH impression.
EXAMPLES
$ trillboards generated sdk-impressionSee code: src/commands/generated/generated-sdk-impression.ts
trillboards generated generated-sdk-qr-beacon
Process beacon signals associated with a prior QR scan.
USAGE
$ trillboards generated generated-sdk-qr-beacon [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
[--data <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--data=<value> JSON request body
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Process beacon signals associated with a prior QR scan.
EXAMPLES
$ trillboards generated sdk-qr-beaconSee code: src/commands/generated/generated-sdk-qr-beacon.ts
trillboards generated generated-sdk-qr-scan
Record a QR-code scan for physical-to-digital attribution.
USAGE
$ trillboards generated generated-sdk-qr-scan [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
[--data <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--data=<value> JSON request body
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Record a QR-code scan for physical-to-digital attribution.
EXAMPLES
$ trillboards generated sdk-qr-scanSee code: src/commands/generated/generated-sdk-qr-scan.ts
trillboards generated generated-sensing-paired-training-upload
Upload a batch of paired camera/CSI training samples.
USAGE
$ trillboards generated generated-sensing-paired-training-upload [--api-key <value>] [--base-url <value>] [--format
json|table|yaml] [--data <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--data=<value> JSON request body
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Upload a batch of paired camera/CSI training samples.
EXAMPLES
$ trillboards generated sensing-paired-training-uploadSee code: src/commands/generated/generated-sensing-paired-training-upload.ts
trillboards help [COMMAND]
Display help for trillboards.
USAGE
$ trillboards help [COMMAND...] [-n]
ARGUMENTS
[COMMAND...] Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for trillboards.See code: @oclif/plugin-help
trillboards listen PORT
Forward live SSE events to a local HTTP server (webhook dev loop)
USAGE
$ trillboards listen PORT [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--events
<value>] [--path <value>]
ARGUMENTS
PORT Local port to forward webhook events to
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--events=<value> [default: *] Comma-separated SSE event types to subscribe to ("*" = all)
--format=<option> Output format
<options: json|table|yaml>
--path=<value> [default: /webhook] HTTP path on the local server to POST events to
DESCRIPTION
Forward live SSE events to a local HTTP server (webhook dev loop)
EXAMPLES
$ trillboards listen 3000
$ trillboards listen 3000 --path /hooks
$ trillboards listen 4000 --events request.logged,error.occurredSee code: src/commands/listen.ts
trillboards login
Authenticate with the Trillboards API
USAGE
$ trillboards login [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Authenticate with the Trillboards API
EXAMPLES
$ trillboards login
TRILLBOARDS_API_KEY=trb_partner_xxx trillboards loginSee code: src/commands/login.ts
trillboards logs tail
Tail real-time request logs via server-sent events
USAGE
$ trillboards logs tail [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--events
<value>] [--status <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--events=<value> [default: request.logged,error.occurred] Comma-separated SSE event types to subscribe to
--format=<option> Output format
<options: json|table|yaml>
--status=<value> Filter by status code pattern (e.g. "4xx", "5xx", "4xx,5xx", "404")
DESCRIPTION
Tail real-time request logs via server-sent events
EXAMPLES
$ trillboards logs tail
$ trillboards logs tail --events error.occurred
$ trillboards logs tail --status 4xx,5xx
$ trillboards logs tail --events request.logged,error.occurred --status 5xxSee code: src/commands/logs/tail.ts
trillboards reconcile
Revenue reconciliation — compare our numbers with partner reports
USAGE
$ trillboards reconcile [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--period <value>]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
--period=<value> [default: 30d] Time period for reconciliation (e.g. 7d, 30d)
DESCRIPTION
Revenue reconciliation — compare our numbers with partner reports
EXAMPLES
$ trillboards reconcile
$ trillboards reconcile --period 7d
$ trillboards reconcile --format jsonSee code: src/commands/reconcile.ts
trillboards sandbox create
Create a sandbox test screen
USAGE
$ trillboards sandbox create [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Create a sandbox test screen
EXAMPLES
$ trillboards sandbox create
$ trillboards sandbox create --format jsonSee code: src/commands/sandbox/create.ts
trillboards sandbox emit EVENT_TYPE
Emit a test event in the sandbox
USAGE
$ trillboards sandbox emit EVENT_TYPE [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [-d
<value>]
ARGUMENTS
EVENT_TYPE Event type to emit (e.g. impression.recorded, heartbeat)
FLAGS
-d, --data=<value> Additional event data (JSON string)
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Emit a test event in the sandbox
EXAMPLES
$ trillboards sandbox emit impression.recorded
$ trillboards sandbox emit heartbeat
$ trillboards sandbox emit impression.recorded --data '{"cpm": 3.50}'See code: src/commands/sandbox/emit.ts
trillboards sandbox reset
Reset the sandbox — delete all test screens and events
USAGE
$ trillboards sandbox reset [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Reset the sandbox — delete all test screens and events
EXAMPLES
$ trillboards sandbox reset
$ trillboards sandbox reset --format jsonSee code: src/commands/sandbox/reset.ts
trillboards sandbox status
Show sandbox status — screens and recent events
USAGE
$ trillboards sandbox status [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Show sandbox status — screens and recent events
EXAMPLES
$ trillboards sandbox status
$ trillboards sandbox status --format jsonSee code: src/commands/sandbox/status.ts
trillboards screens watch
Live fleet dashboard — watch all screens in real-time
USAGE
$ trillboards screens watch [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [--filter
online|offline] [--interval <value>] [--sort name|earnings|fill-rate]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--filter=<option> Filter screens by status
<options: online|offline>
--format=<option> Output format
<options: json|table|yaml>
--interval=<value> [default: 10] Refresh interval in seconds
--sort=<option> [default: name] Sort column
<options: name|earnings|fill-rate>
DESCRIPTION
Live fleet dashboard — watch all screens in real-time
EXAMPLES
$ trillboards screens watch
$ trillboards screens watch --filter online
$ trillboards screens watch --sort earnings
$ trillboards screens watch --format jsonSee code: src/commands/screens/watch.ts
trillboards trigger [EVENT_TYPE]
Fire test events in the sandbox
USAGE
$ trillboards trigger [EVENT_TYPE] [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
ARGUMENTS
[EVENT_TYPE] Event type to fire (e.g. impression_start)
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Fire test events in the sandbox
EXAMPLES
$ trillboards trigger
$ trillboards trigger impression_start
$ trillboards trigger impression_complete --format jsonSee code: src/commands/trigger.ts
trillboards validate FILE
Validate a JSON payload against the API (dry-run)
USAGE
$ trillboards validate FILE [--api-key <value>] [--base-url <value>] [--format json|table|yaml] [-o <value>]
ARGUMENTS
FILE Path to JSON file to validate
FLAGS
-o, --operation=<value> Operation ID for the playground endpoint (e.g. create_screen)
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Validate a JSON payload against the API (dry-run)
EXAMPLES
$ trillboards validate payload.json
$ trillboards validate payload.json --operation create_screenSee code: src/commands/validate.ts
trillboards whoami
Show current partner info and API key status
USAGE
$ trillboards whoami [--api-key <value>] [--base-url <value>] [--format json|table|yaml]
FLAGS
--api-key=<value> [env: TRILLBOARDS_API_KEY] API key (or set TRILLBOARDS_API_KEY env var)
--base-url=<value> [default: https://api.trillboards.com] API base URL
--format=<option> Output format
<options: json|table|yaml>
DESCRIPTION
Show current partner info and API key status
EXAMPLES
$ trillboards whoami
$ trillboards whoami --format jsonSee code: src/commands/whoami.ts
