Channels commands

Reference for the `revenexx channels` commands — every subcommand with a runnable example.

Auto-generated. This page is generated from the revenexx CLI by tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.

Every revenexx channels subcommand. The example shows the required arguments; the options table lists every flag the command accepts, with a ✓ marking required flags. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx channels <command> --help for the live options.

context

Bash
revenexx channels context
FlagRequiredDescription
--channel <channel>Channel code to resolve, overriding the header and the claim.

create

Bash
revenexx channels create \
    --code sample code \
    --name Sample name
FlagRequiredDescription
--code <code>Stable channel code, unique per tenant (e.g. shop, punchout-acme).
--name <name>Display name.
--is-default [value]Mark as the default channel (default false). At most one channel carries it — setting it demotes the previous holder.
--labels <labels>Localized display names keyed by locale.
--position <position>Sort position (default 0).
--status <status>Lifecycle status (default 'active'). What 'inactive' DOES is the tenant's inactive_channel_behavior setting. Served as 'channels.statuses'.
--type <type>Which channel type this is — one of the codes the tenant keeps under GET /channels/types, served with labels as the 'channels.types' vocabulary. Omitted on create, it falls back to the type the tenant flagged as their default.
--unassigned-visibility <unassigned-visibility>This channel's answer to what a row with NO channel assignment means here — the per-channel override of the tenant's unassigned_channel_visibility setting. 'inherit' (default) takes the tenant answer; 'all' shows unassigned rows; 'assigned_only' hides them until they are explicitly assigned, which is the assortment a punchout contract describes. Served as 'channels.unassigned-visibility'.

defaults

Bash
revenexx channels defaults

delete

Bash
revenexx channels delete \
    --id sample-id
FlagRequiredDescription
--id <id>

get

Bash
revenexx channels get \
    --id sample-id
FlagRequiredDescription
--id <id>

list

Bash
revenexx channels list
FlagRequiredDescription
--limit <limit>Page size (default 50, max 200).
--offset <offset>Row offset for pagination (default 0).
--order <order>Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
--filter <column=value>Filter rows by column equality (repeatable).

types-create

Bash
revenexx channels types-create \
    --code '' \
    --title Sample title
FlagRequiredDescription
--code <code>
--title <title>The fallback name. \
--description <description>
--descriptions <descriptions>
--is-default [value]Promote this type; the previous default is demoted.
--labels <labels>
--position <position>
--tone <tone>

types-delete

Bash
revenexx channels types-delete \
    --id sample-id
FlagRequiredDescription
--id <id>

types-get

Bash
revenexx channels types-get \
    --id sample-id
FlagRequiredDescription
--id <id>

types-list

Bash
revenexx channels types-list
FlagRequiredDescription
--limit <limit>Page size (default 50, max 200).
--offset <offset>Row offset for pagination (default 0).
--order <order>Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
--filter <column=value>Filter rows by column equality (repeatable).

types-update

Bash
revenexx channels types-update \
    --id sample-id
FlagRequiredDescription
--id <id>
--description <description>
--descriptions <descriptions>
--is-default [value]Promote this type; the previous default is demoted.
--labels <labels>
--position <position>
--title <title>
--tone <tone>

update

Bash
revenexx channels update \
    --id sample-id
FlagRequiredDescription
--id <id>
--code <code>Stable channel code, unique per tenant (e.g. shop, punchout-acme).
--is-default [value]Mark as the default channel (default false). At most one channel carries it — setting it demotes the previous holder.
--labels <labels>Localized display names keyed by locale.
--name <name>Display name.
--position <position>Sort position (default 0).
--status <status>Lifecycle status (default 'active'). What 'inactive' DOES is the tenant's inactive_channel_behavior setting. Served as 'channels.statuses'.
--type <type>Which channel type this is — one of the codes the tenant keeps under GET /channels/types, served with labels as the 'channels.types' vocabulary. Omitted on create, it falls back to the type the tenant flagged as their default.
--unassigned-visibility <unassigned-visibility>This channel's answer to what a row with NO channel assignment means here — the per-channel override of the tenant's unassigned_channel_visibility setting. 'inherit' (default) takes the tenant answer; 'all' shows unassigned rows; 'assigned_only' hides them until they are explicitly assigned, which is the assortment a punchout contract describes. Served as 'channels.unassigned-visibility'.

visibility

Bash
revenexx channels visibility \
    --items one two three
FlagRequiredDescription
--items [items...]The rows to decide on, each with the channel assignments Baseline holds for it. POST /api/v1/scopes/lookup?dimension=channel answers in exactly this shape. At most 500 — Baseline's own lookup ceiling.
--channel <channel>Channel code to evaluate against. Optional — falls back to x-revenexx-channel, then the scope_context.channel claim, then the tenant's default channel.

vocabularies-get

Bash
revenexx channels vocabularies-get \
    --name statuses
FlagRequiredDescription
--name <name>The vocabulary name — the part after the dot in the qualified id.

vocabularies-list

Bash
revenexx channels vocabularies-list
FlagRequiredDescription
--filter <column=value>Filter rows by column equality (repeatable).
Was this page helpful?