umbraco-doctype

Files (1)

• SKILL.md

SKILL.md (first lines)

# doctype

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

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

## Overview

```text
Document type schema operations.

Task → command:
  Read a type by GUID or alias                         doctype get <id-or-alias>
  Find types by name                                   doctype search --query <text>
  Add / reorder / remove properties, add tabs/groups   doctype add-property, reorder-properties, remove-property --alias <a> --backup --force, add-container
  Change a property's name/description/type/mandatory  doctype update-property <id> --alias <a> --name|--description|--data-type|--mandatory|--no-mandatory … --dry-run
  Create a folder, put a type in a folder              doctype create-folder --name <n> [--parent <id>]; doctype create --json '{..."parent":{"id":…}}' or doctype move <id> --to <folder>
  Allowed blocks, block order, Block Grid groups       datatype block add|reorder|groups … (blocks belong to the Block List/Grid DATA TYPE, not the document type)
  Which data type does a property use?                 doctype get <id> --fields properties
  Is a property actually filled in anywhere?           doctype property-is-used <id-or-alias> --alias <propertyAlias>
  Apply a whole schema from Deploy artifacts           deploy apply --uda-dir <dir> --dry-run
```

## Read Commands

| Command | Description |
|---------|-------------|
| `doctype allowed-in-library` | List document types usable as library elements (Umbraco 18.1+) |
| `doctype children <id>` | Get child document types (paginated; --skip/--take/--all) |
| `doctype get <id-or-alias>` | Get document type by ID (or by exact alias) |
| `doctype list` | List document types (paginated; --skip/--take/--all) |
| `doctype property-is-used <id-or-alias>` | Check whether a property of this document type holds a value anywhere |
| `doctype root` | Get root document types (paginated; --skip/--take/--all) |
| `doctype search` | Search document types |

### allowed-in-library

```bash
umbraco doctype allowed-in-library
```

GET /document-type/allowed-in-library. Lists the element types with allowedInLibrary set — the types 'element create' accepts.

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

### get

```bash
umbraco doctype get <id-or-alias>
```

Fetches a document type by GUID. A non-GUID argument is treated as an alias and resolved through the item search (exact, case-insensitive match); when nothing matches the command says so instead of issuing a request that can only 404. Blocks (allowed blocks, their order, Block Grid groups) live on the Block List/Grid data type: see 'umbraco datatype block --help'.

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

### list

```bash
umbraco doctype list
```

| 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. |
| `--exclude-folders` | bool | false | Alias for --types-only |
| `--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 |
| `--recursive` | bool | false | Walk document type folders recursively |
| `--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) |
| `--types-only` | bool | false | Return document types only, excluding folders |

### property-is-used

```bash
umbraco doctype property-is-used <id-or-alias>
```

GET /property-type/is-used?contentTypeId=&propertyAlias=. The document type is addressed by GUID or by exact alias; --alias names the property on it. The response is a bare boolean: true means removing the property would discard stored values.

| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--alias` | string | — | Property alias on the document type (required) |

### root

From albanistrefi/umbraco_CLI, MIT.

More from albanistrefi/umbraco_CLI