All commands · workspace
pm workspace schema
Manage types, statuses, fields, presets, and workflow policies.
Manage types, statuses, fields, presets, and workflow policies.
Usage
pm workspace schema [options] <subcommand> [name]Arguments
| <subcommand> | Required; schema verb (list/show, add/remove, rename/remap, policy-*), or custom type shorthand | required |
|---|---|---|
| <name> | Definition/source name or item id; policy-mode: advise|refuse | optional |
Options
| --definition <json> | Policy or proposed fields JSON | optional |
|---|---|---|
| --policy <id> | Policy id for policy-approve | optional |
| --message <text> | Audit rationale for a policy mutation | optional |
| --description <text> | Type, status, or field description | optional |
| --default-status <status> | Default status for this type | optional |
| --folder <dir> | Storage folder for items of this custom type | optional |
| --role <value> | Lifecycle role for a custom status (repeatable): draft, active, blocked, terminal, terminal_done, terminal_canceled, default_open, default_close, default_cancel | optional |
| --order <n> | Display/sort order for a custom status | optional |
| --type <type> | Value type for a custom field (add-field): string, number, boolean, string_array, array, object | optional |
| --commands <list> | Field commands (repeatable/csv): create, update, update_many, list, search, calendar, context | optional |
| --cli-flag <flag> | Override the auto-derived CLI flag for a custom field (add-field) | optional |
| --required | Mark a custom field as always required (add-field) | optional |
| --required-on-create | Mark a custom field as required at create time (add-field) | optional |
| --no-allow-unset | Disallow clearing a custom field via --unset (add-field) | optional |
| --required-types <list> | Restrict a custom field's requirement to specific item types (add-field; repeatable, comma-friendly) | optional |
| --infer | Infer custom item types from title-prefix conventions (add-type; preview unless --apply) | optional |
| --min-count <n> | Minimum items sharing a prefix for add-type --infer (default 10) | optional |
| --apply | Register inferred types (add-type --infer); without it the command previews only | optional |
| --to <name> | Target definition name for rename/remap migrations | optional |
| --migration-id <id> | Stable idempotency key for a resumable schema migration | optional |
| --dry-run | Preview rename/remap migrations and workflow-policy actions without writes | optional |
| --author <value> | Mutation author | optional |
| --force | Force ownership/lock override | optional |
Examples
pm workspace schema --help