Nimbu Developer Docs
CLICommand reference

Pages

Generated reference for nimbu pages

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

nimbu pages

Manage pages

nimbu pages batch

Apply multiple page operations from a file

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--fileyesJSON operations object or array
--atomicnotrueFail the whole batch if any operation fails
--localenoContent locale for localized fields
--diffnoShow a unified diff of each changed subtree
--dry-runnoResolve paths and print the operations without writing
--draftnoWrite to the page draft instead of the live page

nimbu pages copy

Copy pages between sites

Flags

FlagRequiredDefaultDescription
--onlyno*Page fullpath or prefix* to copy
--fromyesSource site
--toyesTarget site
--from-hostnoSource API base URL or host
--to-hostnoTarget API base URL or host
--allow-errorsnoContinue on page-level errors

nimbu pages count

Count pages

Flags

FlagRequiredDefaultDescription
--localenoLocale filter; localized resources use it as content locale
--filtersnoFilter by key=value, repeatable

nimbu pages create

Create page from JSON

Arguments

NameRequiredDescription
assignmentsnoInline assignments (e.g. slug=about, title=About)

Flags

FlagRequiredDefaultDescription
--localenoContent locale for localized page fields
--filenoRead page JSON from file (use - for stdin)

nimbu pages delete

Delete page

Flags

FlagRequiredDefaultDescription
--pageyesPage ID or slug

nimbu pages delete-block

Delete a repeatable block

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--pathyesRepeatable path to delete
--diffnoShow a unified diff of the canvas repeatables
--dry-runnoResolve paths and print the operations without writing
--draftnoWrite to the page draft instead of the live page

nimbu pages draft

Work on page drafts (edit and preview without publishing)

nimbu pages draft batch

Apply operations to the page draft

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--fileyesJSON operations object or array
--localenoContent locale for localized fields
--diffnoShow a unified diff of each changed subtree
--dry-runnoResolve paths and print the operations without writing

nimbu pages draft discard

Discard a page draft

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id

nimbu pages draft get

Get the current page draft

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--localenoContent locale for localized fields
--shapenoEmit canvas/repeatable skeleton instead of content
--rawnoEmit the raw draft envelope (content.page_items) instead of the page document

nimbu pages draft preview-url

Print a preview URL for the page draft

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--opennoOpen the preview URL in the browser

nimbu pages draft publish

Publish a page draft to the live page

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--confirmnoReplace live content when the live page changed after this draft was based on it

nimbu pages draft save

Save a whole page draft from a file

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--fileyesDraft JSON file (use - for stdin)
--localenoContent locale for localized fields

nimbu pages get

Get page details

Flags

FlagRequiredDefaultDescription
--fieldsnoComma-separated fields to return
--localenoLocale filter; localized resources use it as content locale
--includenoInclude related resources
--sortnoSort by field, e.g. field or field:desc
--filtersnoFilter by key=value, repeatable
--download-assetsnoDownload page file editables into DIR and rewrite JSON to attachment_path refs
--shapenoEmit canvas/repeatable skeleton instead of content
--outlinenoEmit one compact line per editable (paths usable with pages set --path)
--compactnoJSON only: drop editable timestamps/slug/type, redundant translations, and file noise
--draftnoRead the page draft instead of the live page (works with --shape, --outline, --compact)
--pageyesPage fullpath

nimbu pages insert

Insert a repeatable into a canvas

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--pathyesCanvas path (Blokken, /items/Blokken, or /items/Blokken/repeatables)
--slugnoRepeatable slug to insert
--afternoPlace after this sibling id or 0-based index
--positionno0-based insert index
--filenoJSON items map, or {slug, items} object
--localenoContent locale for localized fields
--diffnoShow a unified diff of the canvas repeatables
--dry-runnoResolve paths and print the operations without writing
--draftnoWrite to the page draft instead of the live page

nimbu pages items

Get a resolved items subtree

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--pathyesHuman or raw path under /items
--localenoContent locale; overlays translations for display

nimbu pages list

List pages

Flags

FlagRequiredDefaultDescription
--fieldsnoComma-separated fields to return
--localenoLocale filter; localized resources use it as content locale
--includenoInclude related resources
--sortnoSort by field, e.g. field or field:desc
--filtersnoFilter by key=value, repeatable
--allnoFetch all pages
--pageno1Page number
--per-pageno25Items per page

nimbu pages move

Move a repeatable within its canvas

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--pathyesRepeatable path to move
--afternoPlace after this sibling id or 0-based index
--positionno0-based target index
--diffnoShow a unified diff of the canvas repeatables
--dry-runnoResolve paths and print the operations without writing
--draftnoWrite to the page draft instead of the live page

nimbu pages schema

Show the page template schema

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id

nimbu pages set

Set one page field or editable by path

Arguments

NameRequiredDescription
valuenoLiteral value to set

Flags

FlagRequiredDefaultDescription
--pageyesPage fullpath or id
--pathyesHuman or raw path to the field or editable
--filenoJSON value from file (use - for stdin)
--from-filenoLocal file to upload as a file editable
--localenoContent locale for localized fields
--diffnoShow a unified diff of the changed subtree
--dry-runnoResolve paths and print the operations without writing
--draftnoWrite to the page draft instead of the live page

nimbu pages update

Update page

Arguments

NameRequiredDescription
assignmentsnoInline assignments (e.g. title=About, published:=true)

Flags

FlagRequiredDefaultDescription
--fieldsnoComma-separated fields to return
--localenoLocale filter; localized resources use it as content locale
--includenoInclude related resources
--sortnoSort by field, e.g. field or field:desc
--filtersnoFilter by key=value, repeatable
--pageyesPage fullpath
--filenoRead page JSON from file (use - for stdin)
--replacenoReplace canvases entirely (destructive rebuild)
--allow-empty-canvasnoAllow emptying a canvas
--allow-empty-filenoAllow file editables with no attachment or URL to clear assets
--dry-runnoFetch, merge, and print the PATCH body without sending it

nimbu pages versions

Manage page versions

nimbu pages versions get

Get a page version

Flags

FlagRequiredDefaultDescription
--pageyesPage ID or path
--page-versionyesPage version ID

nimbu pages versions list

List page versions

Flags

FlagRequiredDefaultDescription
--pageyesPage ID or path

nimbu pages versions restore

Restore a page version

Flags

FlagRequiredDefaultDescription
--pageyesPage ID or path
--page-versionyesPage version ID

On this page