@trillboards/cli

v0.1.0

Published

16 days ago

Official CLI for the Trillboards DOOH API

0High
0Medium
0Low

snehdhruv

oclif cli trillboards dooh

trillboards-cli

A new CLI generated with oclif

Usage

$ npm install -g @trillboards/cli
$ trillboards COMMAND
running command...
$ trillboards (--version)
@trillboards/cli/0.1.0 darwin-arm64 node-v22.22.0
$ trillboards --help [COMMAND]
USAGE
  $ trillboards COMMAND
...

Commands

`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_name

See 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 3

See 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-cache

See 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 json

See 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 json

See code: src/commands/billing/usage.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 json

See code: src/commands/debug.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 doctor

See 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 json

See 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 json

See 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 json

See 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 json

See 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 query

See 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-aggregate

See 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-screens

See 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-screens

See 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-dsl

See 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-history

See 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-live

See 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-search

See 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-stats

See 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-stream

See 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-usage

See code: src/commands/generated/generated-data-api-usage.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-manifest

See 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-healthcheck

See code: src/commands/generated/generated-example-healthcheck.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-run

See code: src/commands/generated/generated-playground-dry-run.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 get

See 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-enrich

See 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-impression

See 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-beacon

See 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-scan

See 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-upload

See 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.occurred

See 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 login

See 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 5xx

See 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 json

See 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 json

See 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 json

See 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 json

See 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 json

See 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 json

See 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_screen

See 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 json

See code: src/commands/whoami.ts

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

trillboards-cli

Usage

Commands

trillboards api METHOD PATH

trillboards audience live SCREEN_ID

trillboards autocomplete [SHELL]

trillboards billing

trillboards billing usage

trillboards debug SCREEN_ID

trillboards doctor

trillboards earnings [MODE]

trillboards endpoints

trillboards errors [CODE]

trillboards fill-rate

trillboards generated generated-changelog-query

trillboards generated generated-data-api-aggregate

trillboards generated generated-data-api-list-screens

trillboards generated generated-data-api-lookalike-screens

trillboards generated generated-data-api-query-dsl

trillboards generated generated-data-api-screen-audience-history SCREENID

trillboards generated generated-data-api-screen-audience-live SCREENID

trillboards generated generated-data-api-semantic-search

trillboards generated generated-data-api-stats

trillboards generated generated-data-api-stream

trillboards generated generated-data-api-usage

trillboards generated generated-device-ota-manifest

trillboards generated generated-example-healthcheck

trillboards generated generated-playground-dry-run OPERATION_ID

trillboards generated generated-request-metadata-get REQUEST_ID

trillboards generated generated-sdk-enrich

trillboards generated generated-sdk-impression

trillboards generated generated-sdk-qr-beacon

trillboards generated generated-sdk-qr-scan

trillboards generated generated-sensing-paired-training-upload

trillboards help [COMMAND]

trillboards listen PORT

trillboards login

trillboards logs tail

trillboards reconcile

trillboards sandbox create

trillboards sandbox emit EVENT_TYPE

trillboards sandbox reset

trillboards sandbox status

trillboards screens watch

trillboards trigger [EVENT_TYPE]

trillboards validate FILE

trillboards whoami