prb cookie-banner command reference
Reference for 21 commands under prb cookie-banner, including usage, flag types and defaults, required flags, source examples, and implementation links
Manage cookie banners. This page documents 21 commands under prb cookie-banner.
Flags and examples below come from the command definitions. A Required flag is explicitly marked required by Cobra; an unmarked flag can still be needed by runtime validation or a non-interactive workflow. Empty strings and empty lists are registered defaults, not sample values.
Every command also inherits the global flags. Run prb <command> --help to check your installed version. Replace placeholder IDs and names in source examples before running them. Return to the complete CLI command reference to browse another command.
Commands
Section titled “Commands”| Command | Description | Usage | Source |
|---|---|---|---|
prb cookie-banner | Manage cookie banners. | prb cookie-banner <command> | View implementation |
prb cookie-banner activate | Activate a cookie banner. | prb cookie-banner activate <id> | View implementation |
prb cookie-banner add-gvl-vendor | Add an IAB GVL vendor to a cookie banner. | prb cookie-banner add-gvl-vendor <cookie-banner-id> | View implementation |
prb cookie-banner create | Create a new cookie banner. | prb cookie-banner create | View implementation |
prb cookie-banner deactivate | Deactivate a cookie banner. | prb cookie-banner deactivate <id> | View implementation |
prb cookie-banner delete | Delete a cookie banner. | prb cookie-banner delete <id> | View implementation |
prb cookie-banner get-gvl-catalog | Show the current IAB GVL catalog versions. | prb cookie-banner get-gvl-catalog | View implementation |
prb cookie-banner latest-version | Show the latest version of a cookie banner. | prb cookie-banner latest-version <id> | View implementation |
prb cookie-banner list | List cookie banners in an organization. | prb cookie-banner list | View implementation |
prb cookie-banner list-gvl-catalog | List IAB GVL vendors from the global catalog. | prb cookie-banner list-gvl-catalog | View implementation |
prb cookie-banner list-gvl-vendors | List IAB GVL vendors selected on a cookie banner. | prb cookie-banner list-gvl-vendors <cookie-banner-id> | View implementation |
prb cookie-banner list-samples | List cookie banner samples. | prb cookie-banner list-samples <id> | View implementation |
prb cookie-banner publish | Publish the current draft version. | prb cookie-banner publish <id> | View implementation |
prb cookie-banner published-version | Show the latest published version of a cookie banner. | prb cookie-banner published-version <id> | View implementation |
prb cookie-banner regenerate-policy | Re-arm tracker policy generation for a published cookie banner. | prb cookie-banner regenerate-policy <id> | View implementation |
prb cookie-banner remove-gvl-vendor | Remove an IAB GVL vendor from a cookie banner. | prb cookie-banner remove-gvl-vendor <cookie-banner-id> | View implementation |
prb cookie-banner start-sample | Start a cookie banner sample. | prb cookie-banner start-sample <id> | View implementation |
prb cookie-banner stop-sample | Stop a cookie banner sample. | prb cookie-banner stop-sample <id> | View implementation |
prb cookie-banner translate | Upsert a translation for a language. | prb cookie-banner translate <id> | View implementation |
prb cookie-banner update | Update a cookie banner. | prb cookie-banner update <id> | View implementation |
prb cookie-banner view | View a cookie banner. | prb cookie-banner view <id> | View implementation |
prb cookie-banner
Section titled “prb cookie-banner”Manage cookie banners.
prb cookie-banner <command>prb cookie-banner activate
Section titled “prb cookie-banner activate”Activate a cookie banner.
prb cookie-banner activate <id>Requires 1 positional argument.
prb cookie-banner add-gvl-vendor
Section titled “prb cookie-banner add-gvl-vendor”Add an IAB GVL vendor to a cookie banner.
prb cookie-banner add-gvl-vendor <cookie-banner-id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--iab-vendor-id | integer | 0 | — | IAB GVL vendor ID (required) |
prb cookie-banner create
Section titled “prb cookie-banner create”Create a new cookie banner.
prb cookie-banner create| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--consent-expiry-days | integer | 365 | — | Days until consent expires |
--cookie-policy-url | string | "" | — | Cookie policy URL (required) |
--name | string | "" | — | Banner name (required) |
--org | string | "" | — | Organization ID |
--origin | string | "" | — | Website origin (required) |
--privacy-policy-url | string | "" | — | Privacy policy URL |
prb cookie-banner deactivate
Section titled “prb cookie-banner deactivate”Deactivate a cookie banner.
prb cookie-banner deactivate <id>Requires 1 positional argument.
prb cookie-banner delete
Section titled “prb cookie-banner delete”Delete a cookie banner.
prb cookie-banner delete <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--yes, -y | boolean | false | — | Skip confirmation prompt |
prb cookie-banner get-gvl-catalog
Section titled “prb cookie-banner get-gvl-catalog”Show the current IAB GVL catalog versions.
prb cookie-banner get-gvl-catalogAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--json | boolean | false | — | Output JSON (same as —output json) |
--output, -o | string | "" | — | Output format: json, table (default) |
prb cookie-banner latest-version
Section titled “prb cookie-banner latest-version”Show the latest version of a cookie banner.
prb cookie-banner latest-version <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--json | boolean | false | — | Output JSON (same as —output json) |
--output, -o | string | "" | — | Output format: json, table (default) |
prb cookie-banner list
Section titled “prb cookie-banner list”List cookie banners in an organization.
prb cookie-banner listAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit, -L | integer | 30 | — | Maximum number of items |
--org | string | "" | — | Organization ID |
--output, -o | string | "" | — | Output format: json, table (default) |
prb cookie-banner list-gvl-catalog
Section titled “prb cookie-banner list-gvl-catalog”List IAB GVL vendors from the global catalog.
prb cookie-banner list-gvl-catalogAccepts no positional arguments.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--cookie-banner-id | string | "" | — | Cookie banner ID (required with —membership) |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit | integer | 50 | — | Maximum number of vendors to return |
--membership | string | "" | — | Filter by banner membership: ON_BANNER or NOT_ON_BANNER |
--output, -o | string | "" | — | Output format: json, table (default) |
--query | string | "" | — | Search by name or IAB vendor ID |
prb cookie-banner list-gvl-vendors
Section titled “prb cookie-banner list-gvl-vendors”List IAB GVL vendors selected on a cookie banner.
prb cookie-banner list-gvl-vendors <cookie-banner-id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit | integer | 50 | — | Maximum number of vendors to return |
--output, -o | string | "" | — | Output format: json, table (default) |
prb cookie-banner list-samples
Section titled “prb cookie-banner list-samples”List cookie banner samples.
prb cookie-banner list-samples <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--after | string | "" | — | Cursor from the previous page (the Next cursor line) |
--json | boolean | false | — | Output JSON (same as —output json) |
--limit, -L | integer | 30 | — | Maximum number of items |
--output, -o | string | "" | — | Output format: json, table (default) |
prb cookie-banner publish
Section titled “prb cookie-banner publish”Publish the current draft version.
prb cookie-banner publish <id>Requires 1 positional argument.
prb cookie-banner published-version
Section titled “prb cookie-banner published-version”Show the latest published version of a cookie banner.
prb cookie-banner published-version <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--json | boolean | false | — | Output JSON (same as —output json) |
--output, -o | string | "" | — | Output format: json, table (default) |
prb cookie-banner regenerate-policy
Section titled “prb cookie-banner regenerate-policy”Re-arm tracker policy generation for a published cookie banner.
prb cookie-banner regenerate-policy <id>Requires 1 positional argument.
prb cookie-banner remove-gvl-vendor
Section titled “prb cookie-banner remove-gvl-vendor”Remove an IAB GVL vendor from a cookie banner.
prb cookie-banner remove-gvl-vendor <cookie-banner-id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--iab-vendor-id | integer | 0 | — | IAB GVL vendor ID (required) |
prb cookie-banner start-sample
Section titled “prb cookie-banner start-sample”Start a cookie banner sample.
prb cookie-banner start-sample <id>Requires 1 positional argument.
prb cookie-banner stop-sample
Section titled “prb cookie-banner stop-sample”Stop a cookie banner sample.
prb cookie-banner stop-sample <id>Requires 1 positional argument.
prb cookie-banner translate
Section titled “prb cookie-banner translate”Upsert a translation for a language.
prb cookie-banner translate <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--language | string | "" | Required | Language code (e.g. fr, de, es) |
--translations | string | "" | Required | Translations JSON |
prb cookie-banner update
Section titled “prb cookie-banner update”Update a cookie banner.
prb cookie-banner update <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--consent-expiry-days | integer | 0 | — | Days until consent expires |
--cookie-policy-url | string | "" | — | Cookie policy URL |
--default-language | string | "" | — | Default language code |
--force-opt-in | boolean | false | — | Show the opt-in banner to every visitor regardless of regulation |
--name | string | "" | — | Banner name |
--privacy-policy-url | string | "" | — | Privacy policy URL |
--publisher-country-code | string | "" | — | IAB TCF publisher country (ISO 3166-1 alpha-2, or AA) |
--resource-reporting-enabled | boolean | true | — | Whether the SDK reports detected resources |
prb cookie-banner view
Section titled “prb cookie-banner view”View a cookie banner.
prb cookie-banner view <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--json | boolean | false | — | Output JSON (same as —output json) |
--output, -o | string | "" | — | Output format: json, table (default) |