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
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--file | yes | JSON operations object or array | |
--atomic | no | true | Fail the whole batch if any operation fails |
--locale | no | Content locale for localized fields | |
--diff | no | Show a unified diff of each changed subtree | |
--dry-run | no | Resolve paths and print the operations without writing | |
--draft | no | Write to the page draft instead of the live page |
nimbu pages copy
Copy pages between sites
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--only | no | * | Page fullpath or prefix* to copy |
--from | yes | Source site | |
--to | yes | Target site | |
--from-host | no | Source API base URL or host | |
--to-host | no | Target API base URL or host | |
--allow-errors | no | Continue on page-level errors |
nimbu pages count
Count pages
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--locale | no | Locale filter; localized resources use it as content locale | |
--filters | no | Filter by key=value, repeatable |
nimbu pages create
Create page from JSON
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline assignments (e.g. slug=about, title=About) |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--locale | no | Content locale for localized page fields | |
--file | no | Read page JSON from file (use - for stdin) |
nimbu pages delete
Delete page
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page ID or slug |
nimbu pages delete-block
Delete a repeatable block
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--path | yes | Repeatable path to delete | |
--diff | no | Show a unified diff of the canvas repeatables | |
--dry-run | no | Resolve paths and print the operations without writing | |
--draft | no | Write 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
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--file | yes | JSON operations object or array | |
--locale | no | Content locale for localized fields | |
--diff | no | Show a unified diff of each changed subtree | |
--dry-run | no | Resolve paths and print the operations without writing |
nimbu pages draft discard
Discard a page draft
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id |
nimbu pages draft get
Get the current page draft
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--locale | no | Content locale for localized fields | |
--shape | no | Emit canvas/repeatable skeleton instead of content | |
--raw | no | Emit 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
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--open | no | Open the preview URL in the browser |
nimbu pages draft publish
Publish a page draft to the live page
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--confirm | no | Replace 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
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--file | yes | Draft JSON file (use - for stdin) | |
--locale | no | Content locale for localized fields |
nimbu pages get
Get page details
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--fields | no | Comma-separated fields to return | |
--locale | no | Locale filter; localized resources use it as content locale | |
--include | no | Include related resources | |
--sort | no | Sort by field, e.g. field or field:desc | |
--filters | no | Filter by key=value, repeatable | |
--download-assets | no | Download page file editables into DIR and rewrite JSON to attachment_path refs | |
--shape | no | Emit canvas/repeatable skeleton instead of content | |
--outline | no | Emit one compact line per editable (paths usable with pages set --path) | |
--compact | no | JSON only: drop editable timestamps/slug/type, redundant translations, and file noise | |
--draft | no | Read the page draft instead of the live page (works with --shape, --outline, --compact) | |
--page | yes | Page fullpath |
nimbu pages insert
Insert a repeatable into a canvas
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--path | yes | Canvas path (Blokken, /items/Blokken, or /items/Blokken/repeatables) | |
--slug | no | Repeatable slug to insert | |
--after | no | Place after this sibling id or 0-based index | |
--position | no | 0-based insert index | |
--file | no | JSON items map, or {slug, items} object | |
--locale | no | Content locale for localized fields | |
--diff | no | Show a unified diff of the canvas repeatables | |
--dry-run | no | Resolve paths and print the operations without writing | |
--draft | no | Write to the page draft instead of the live page |
nimbu pages items
Get a resolved items subtree
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--path | yes | Human or raw path under /items | |
--locale | no | Content locale; overlays translations for display |
nimbu pages list
List pages
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--fields | no | Comma-separated fields to return | |
--locale | no | Locale filter; localized resources use it as content 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 |
nimbu pages move
Move a repeatable within its canvas
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--path | yes | Repeatable path to move | |
--after | no | Place after this sibling id or 0-based index | |
--position | no | 0-based target index | |
--diff | no | Show a unified diff of the canvas repeatables | |
--dry-run | no | Resolve paths and print the operations without writing | |
--draft | no | Write to the page draft instead of the live page |
nimbu pages schema
Show the page template schema
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id |
nimbu pages set
Set one page field or editable by path
Arguments
| Name | Required | Description |
|---|---|---|
value | no | Literal value to set |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page fullpath or id | |
--path | yes | Human or raw path to the field or editable | |
--file | no | JSON value from file (use - for stdin) | |
--from-file | no | Local file to upload as a file editable | |
--locale | no | Content locale for localized fields | |
--diff | no | Show a unified diff of the changed subtree | |
--dry-run | no | Resolve paths and print the operations without writing | |
--draft | no | Write to the page draft instead of the live page |
nimbu pages update
Update page
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline assignments (e.g. title=About, published:=true) |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--fields | no | Comma-separated fields to return | |
--locale | no | Locale filter; localized resources use it as content locale | |
--include | no | Include related resources | |
--sort | no | Sort by field, e.g. field or field:desc | |
--filters | no | Filter by key=value, repeatable | |
--page | yes | Page fullpath | |
--file | no | Read page JSON from file (use - for stdin) | |
--replace | no | Replace canvases entirely (destructive rebuild) | |
--allow-empty-canvas | no | Allow emptying a canvas | |
--allow-empty-file | no | Allow file editables with no attachment or URL to clear assets | |
--dry-run | no | Fetch, merge, and print the PATCH body without sending it |
nimbu pages versions
Manage page versions
nimbu pages versions get
Get a page version
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page ID or path | |
--page-version | yes | Page version ID |
nimbu pages versions list
List page versions
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page ID or path |
nimbu pages versions restore
Restore a page version
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--page | yes | Page ID or path | |
--page-version | yes | Page version ID |