umbraco-document

Files (1)

• SKILL.md

SKILL.md (first lines)

# document

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

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

## Overview

```text
Document and content management operations.

Task → command:
  Read a document, find documents                      document get <id>, document search --query <text>, document grep
  Change one property                                  document update <id> --property <alias> --value <v> --backup
  Change many documents the same way                   document update --ids a,b,c --merge-json '{...}' --force   (or --from-file ids.txt)
  Publish one / many                                   document publish <id>; document publish --ids a,b,c --force
  Change and publish many in one pass                  document update --ids … --merge-json … --save-and-publish --force
  Per-row values from a spreadsheet                    document csv-update --file rows.csv --property <alias>
  Undo a write                                         document restore-backup <file>   (from any --backup)
  Publish a whole subtree                              document publish-descendants <id>
```

## Read Commands

| Command | Description |
|---------|-------------|
| `document ancestors <id>` | Get ancestor documents |
| `document are-referenced` | Bulk check: which of these document IDs are referenced by something |
| `document audit-log <id>` | List the audit trail for a document (who did what, when) |
| `document bin children <id>` | List children of a trashed document item |
| `document bin list` | List document items at the recycle bin root |
| `document bin original-parent <id>` | Get the original parent of a trashed document item (the default restore target) |
| `document children <id>` | Get child documents (paginated; --skip/--take/--all) |
| `document domains get <id>` | Get the domains assigned to a document |
| `document get <id>` | Get a document by ID |
| `document grep <substring>` | Exhaustively scan document property values for an exact substring |
| `document public-access get <id>` | Get the public-access (member protection) rules on a document |
| `document publish-descendants-result <id> <task-id>` | Check the progress of an asynchronous publish-descendants run |
| `document referenced-descendants <id>` | List items that reference this document or any of its descendants |
| `document references <id>` | List items that reference this document (paginated; --skip/--take/--all) |
| `document root` | Get root documents (paginated; --skip/--take/--all) |
| `document search` | Search documents |
| `document urls <id> [<id>...]` | Get published document URLs |
| `document version get <version-id>` | Get a stored document version (the full payload as it was) |
| `document version list <document-id>` | List stored versions of a document (paginated; --skip/--take/--all) |

### ancestors

```bash
umbraco document ancestors <id>
```

### are-referenced

```bash
umbraco document are-referenced
```

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--ids` | string | — | Comma-separated document GUIDs to check (required) |

### audit-log

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

GET /document/{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) |

### bin children

```bash
umbraco document bin children <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) |

### bin list

```bash
umbraco document bin list
```

GET /recycle-bin/document/root. Paginated; use 'bin children <id>' to descend into trashed subtrees.

| 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) |

From albanistrefi/umbraco_CLI, MIT.

More from albanistrefi/umbraco_CLI