Channels

Generated from the CLI command contract. Do not edit this page manually.

`nimbu channels`

Manage channels and entries

`nimbu channels copy`

Copy channel configuration between sites

Flags

Flag	Required	Description
`--all`	no	Copy all channels from source to target
`--from`	yes	Source site/channel or site when using --all
`--to`	yes	Target site/channel or site when using --all
`--from-host`	no	Source API base URL or host
`--to-host`	no	Target API base URL or host

`nimbu channels create`

Create a channel from JSON or inline assignments

Arguments

Name	Required	Description
`assignments`	no	Inline assignments (e.g. name=Testimonials slug=testimonials title_field=author; customizations:=@fields.json)

Flags

Flag	Required	Default	Description
`--file`	no		Read channel JSON from file (use - for stdin)

`nimbu channels delete`

Delete a channel (requires --force)

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel ID or slug

`nimbu channels diff`

Diff channel configuration between sites

Flags

Flag	Required	Description
`--from`	yes	Source site/channel
`--to`	yes	Target site/channel
`--from-host`	no	Source API base URL or host
`--to-host`	no	Target API base URL or host

`nimbu channels empty`

Empty a channel after strict confirmation

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel ID or slug
`--confirm`	no		Exact channel slug confirmation

`nimbu channels entries`

Manage channel entries

`nimbu channels entries copy`

Copy channel entries between sites

Flags

Flag	Required	Description
`--from`	yes	Source site/channel
`--to`	yes	Target site/channel
`--from-host`	no	Source API base URL or host
`--to-host`	no	Target API base URL or host
`--recursive`	no	Recursively copy referenced channel entries
`--only`	no	Comma-separated channel allowlist when using --recursive
`--query`	no	Raw query string to append to the source entry list
`--where`	no	Where expression for source entry selection
`--per-page`	no	Items per page
`--upsert`	no	Comma-separated upsert fields, optionally channel-scoped as channel:field
`--copy-customers`	no	Copy related customers for owners and customer fields
`--allow-errors`	no	Continue on item-level validation errors
`--dry-run`	no	Reserved for parity; currently reports planned selection only

`nimbu channels entries count`

Count entries

Flags

Flag	Required	Description
`--locale`	no	Filter by locale
`--filters`	no	Filter by key=value, repeatable
`--channel`	yes	Channel ID or slug

`nimbu channels entries create`

Create entry from JSON

Arguments

Name	Required	Description
`assignments`	no	Inline assignments (e.g. title=Hello, fields.teaser=Text)

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel ID or slug
`--file`	no		Read entry JSON from file (use - for stdin)

`nimbu channels entries delete`

Delete entry

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel ID or slug
`--entry`	yes		Entry ID or slug

`nimbu channels entries gallery`

Manage gallery fields on channel entries

`nimbu channels entries gallery add`

Append gallery images

Flags

Flag	Required	Description
`--channel`	yes	Channel ID or slug
`--entry`	yes	Entry ID or slug
`--field`	yes	Gallery field name
`--image`	no	Local image path (repeatable)
`--caption`	no	Caption for each image, matched by order
`--position`	no	Position for each image, matched by order
`--locale`	no	Content locale for localized channel fields
`--dry-run`	no	Print the payload without updating the entry

`nimbu channels entries gallery list`

List gallery images

Flags

Flag	Required	Description
`--channel`	yes	Channel ID or slug
`--entry`	yes	Entry ID or slug
`--field`	yes	Gallery field name
`--locale`	no	Content locale for localized channel fields

`nimbu channels entries gallery remove`

Remove gallery images

Flags

Flag	Required	Description
`--channel`	yes	Channel ID or slug
`--entry`	yes	Entry ID or slug
`--field`	yes	Gallery field name
`--image-id`	yes	Gallery image ID to remove (repeatable)
`--locale`	no	Content locale for localized channel fields
`--dry-run`	no	Print the payload without updating the entry

`nimbu channels entries gallery reorder`

Reorder gallery images

Flags

Flag	Required	Description
`--channel`	yes	Channel ID or slug
`--entry`	yes	Entry ID or slug
`--field`	yes	Gallery field name
`--order`	yes	Comma-separated gallery image IDs in desired order
`--locale`	no	Content locale for localized channel fields
`--dry-run`	no	Print the payload without updating the entry

`nimbu channels entries gallery set`

Replace gallery images

Flags

Flag	Required	Description
`--channel`	yes	Channel ID or slug
`--entry`	yes	Entry ID or slug
`--field`	yes	Gallery field name
`--image`	no	Local image path (repeatable)
`--caption`	no	Caption for each image, matched by order
`--position`	no	Position for each image, matched by order
`--locale`	no	Content locale for localized channel fields
`--dry-run`	no	Print the payload without updating the entry

`nimbu channels entries gallery update`

Update one gallery image

Flags

Flag	Required	Description
`--channel`	yes	Channel ID or slug
`--entry`	yes	Entry ID or slug
`--field`	yes	Gallery field name
`--image-id`	yes	Gallery image ID
`--caption`	no	Updated caption
`--position`	no	Updated position
`--image`	no	Replacement local image path
`--locale`	no	Content locale for localized channel fields
`--dry-run`	no	Print the payload without updating the entry

`nimbu channels entries get`

Get entry by ID or slug

Flags

Flag	Required	Description
`--fields`	no	Comma-separated fields to return
`--locale`	no	Filter by locale
`--include`	no	Include related resources
`--sort`	no	Sort by field, e.g. field or field:desc
`--filters`	no	Filter by key=value, repeatable
`--channel`	yes	Channel ID or slug
`--entry`	yes	Entry ID or slug

`nimbu channels entries list`

List channel entries

Flags

Flag	Required	Default	Description
`--fields`	no		Comma-separated fields to return
`--locale`	no		Filter by locale
`--include`	no		Include related resources
`--sort`	no		Sort by field, e.g. field or field:desc
`--filters`	no		Filter by key=value, repeatable
`--channel`	yes		Channel ID or slug
`--all`	no		Fetch all pages
`--page`	no	`1`	Page number
`--per-page`	no	`25`	Items per page

`nimbu channels entries update`

Update entry

Arguments

Name	Required	Description
`assignments`	no	Inline assignments (e.g. title=Hello, fields.teaser=Text)

Flags

Flag	Required	Description
`--channel`	yes	Channel ID or slug
`--entry`	yes	Entry ID or slug
`--locale`	no	Content locale for localized channel fields
`--file`	no	Read entry JSON from file (use - for stdin)

`nimbu channels fields`

Manage channel fields

`nimbu channels fields add`

Add a channel field

Arguments

Name	Required	Description
`assignments`	no	Field attributes (e.g. type=string label=Title)

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel slug
`--name`	yes		Field name

`nimbu channels fields apply`

Apply channel fields from JSON

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel slug
`--file`	yes		Read field JSON array from file (use - for stdin)

`nimbu channels fields delete`

Delete a channel field

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel slug
`--field`	yes		Field ID or name

`nimbu channels fields diff`

Diff channel fields against JSON

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel slug
`--file`	yes		Read field JSON array from file (use - for stdin)

`nimbu channels fields list`

List channel fields

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel slug

`nimbu channels fields replace`

Replace channel fields from JSON

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel slug
`--file`	yes		Read field JSON array from file (use - for stdin)

`nimbu channels fields update`

Update a channel field

Arguments

Name	Required	Description
`assignments`	no	Field attributes to update (e.g. label=Headline required:=true)

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel slug
`--field`	yes		Field ID or name

`nimbu channels get`

Get channel details

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel slug

`nimbu channels info`

Show rich channel info and TypeScript output

Flags

Flag	Required	Default	Description
`--channel`	yes		Channel slug or site/channel
`--typescript`	no		Render a TypeScript interface instead of the rich summary

`nimbu channels list`

List channels

Flags

Flag	Required	Default	Description
`--fields`	no		Comma-separated fields to return
`--locale`	no		Filter by locale
`--include`	no		Include related resources
`--sort`	no		Sort by field, e.g. field or field:desc
`--filters`	no		Filter by key=value, repeatable
`--all`	no		Fetch all pages
`--page`	no	`1`	Page number
`--per-page`	no	`25`	Items per page
`--with-entry-count`	no	`true`	Fetch entry count for each channel
`--no-entry-count`	no		Skip fetching entry count for each channel

On this page