umbraco-blueprint

Files (1)

• SKILL.md

SKILL.md (first lines)

# blueprint

> **PREREQUISITE:** Read `../umbraco-shared/SKILL.md` for auth, global flags, and security rules.

```bash
umbraco blueprint <command> [flags]
```

## Overview

```text
Document blueprints: reusable content presets for new documents.

A blueprint is a saved set of property values for one document type. The
backoffice offers it when an editor creates a document; from the CLI the
same thing is 'document create --from-blueprint <id>'.

Task → command:
  Browse the blueprint tree                            blueprint list; blueprint children <folder-id>
  Locate one in the tree                               blueprint ancestors <id>; blueprint siblings <id>
  Read one blueprint and its values                    blueprint get <id>
  Resolve several GUIDs to names in one call           blueprint items --ids <a,b>
  See who changed one, and when                        blueprint audit-log <id>
  Turn an existing document into a blueprint           blueprint create-from-document <document-id> --name <n> [--parent <folder-id>]
  Build a blueprint from scratch                       blueprint create --print-template, then blueprint create --json '{...}'
  Change the stored values                             blueprint update <id> --merge-json '{...}' --backup
  Organize the tree                                    blueprint create-folder --name <n> [--parent <id>]; blueprint move <id> --to <folder-id>
  Inspect the document payload it produces             blueprint scaffold <id>
  Create a document from it                            document create --from-blueprint <id> --parent <doc-id>
  Remove one                                           blueprint delete <id> --force; blueprint delete-folder <id> --force
```

## Read Commands

| Command | Description |
|---------|-------------|
| `blueprint ancestors <id>` | List the folders a blueprint sits under, root first |
| `blueprint audit-log <id>` | List the audit trail for a blueprint (who did what, when) |
| `blueprint children <parent-id>` | List blueprints inside a folder (paginated; --skip/--take/--all) |
| `blueprint get <id>` | Get a blueprint by ID |
| `blueprint items` | Resolve blueprint GUIDs to names in one call |
| `blueprint list` | List blueprints and folders at the tree root (paginated; --skip/--take/--all) |
| `blueprint scaffold <id>` | Print the document skeleton a blueprint produces |
| `blueprint siblings <id>` | List the tree entries around a blueprint or folder |

### ancestors

```bash
umbraco blueprint ancestors <id>
```

GET /tree/document-blueprint/ancestors?descendantId={id}. Answers with the folder chain above the blueprint (or folder), root first and ending with the entry itself, so an id seen in a payload can be placed in the tree without walking it from the root.

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--fields` | string | — | Limit response fields (comma-separated top-level keys) |

### audit-log

```bash
umbraco blueprint audit-log <id>
```

GET /document-blueprint/{id}/audit-log. Pass --params for orderDirection or sinceDate filters, e.g. --params '{"sinceDate":"2026-01-01T00:00:00Z"}'.

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--all` | bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
| `--fields` | string | — | Limit response fields (comma-separated top-level keys) |
| `--first-n` | int | 0 | Return only the first N items from item collections |
| `--ids-only` | bool | false | Return only item IDs for item collections |
| `--params` | string | — | Query parameters as JSON |
| `--skip` | int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
| `--summarize` | bool | false | Return only id/name/alias fields for item collections |
| `--take` | int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |

### children

```bash
umbraco blueprint children <parent-id>
```

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--all` | bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
| `--fields` | string | — | Limit response fields (comma-separated top-level keys) |
| `--first-n` | int | 0 | Return only the first N items from item collections |
| `--ids-only` | bool | false | Return only item IDs for item collections |
| `--params` | string | — | Query parameters as JSON |
| `--skip` | int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
| `--summarize` | bool | false | Return only id/name/alias fields for item collections |
| `--take` | int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |

### get

```bash
umbraco blueprint get <id>
```

GET /document-blueprint/{id}. The response carries documentType, values and variants; the blueprint's name lives on variants[].name, not at the top level.

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--fields` | string | — | Limit response fields (comma-separated top-level keys) |

### items

```bash
umbraco blueprint items
```

GET /item/document-blueprint?id=…. The item read for blueprints: pass the GUIDs seen in other payloads and get their names and document types back without one request per ID.

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--fields` | string | — | Limit response fields (comma-separated top-level keys) |
| `--ids` | string | — | Comma-separated blueprint GUIDs (required) |

### list

From albanistrefi/umbraco_CLI, MIT.

More from albanistrefi/umbraco_CLI