All commands · lifecycle
pm update
Update item fields and metadata.
Mutates existing item fields while preserving history and lock safety.
Usage
pm update [options] [command] <id>Arguments
| <id> | Item id | required |
|---|
Options
| --title, -t <value> | Set title | optional |
|---|---|---|
| --description, -d <value> | Set description | optional |
| --body, -b <value> | Set body (allow empty string) | optional |
| --status, -s <value> | Set status (use close command for closed) | optional |
| --close-reason <value> | Set close reason | optional |
| --priority, -p <value> | Set priority | optional |
| --type <value> | Set type | optional |
| --tags <value> | Set comma-separated tags (replaces existing). Use --add-tags / --remove-tags to mutate additively. | optional |
| --add-tags <value> | Add tags to the existing list without replacing it (repeatable; CSV accepted) | optional |
| --remove-tags <value> | Remove tags from the existing list (repeatable; CSV accepted) | optional |
| --deadline <value> | Set deadline (ISO/date string or relative) | optional |
| --estimate, --estimated-minutes <value> | Set estimated minutes | optional |
| --acceptance-criteria <value> | Replace the complete acceptance-criteria list (repeatable values join with '; '); use --remove-ac plus --add-ac for one-entry repair | optional |
| --add-ac <value> | Add one semicolon-free acceptance criterion without replacing the existing list (repeatable) | optional |
| --remove-ac <value> | Remove one semicolon-free acceptance criterion by exact text match; fails if any selector is unmatched (repeatable) | optional |
| --definition-of-ready <value> | Set definition of ready | optional |
| --order <value> | Set planning order/rank integer | optional |
| --goal <value> | Set goal identifier | optional |
| --objective <value> | Set objective identifier | optional |
| --value <value> | Set business value summary | optional |
| --impact <value> | Set business impact summary | optional |
| --outcome <value> | Set expected outcome summary | optional |
| --why-now <value> | Set why-now rationale | optional |
| --author <value> | Mutation author | optional |
| --message <value> | Mutation message | optional |
| --assignee <value> | Set assignee | optional |
| --parent <value> | Set parent item ID | optional |
| --allow-missing-parent | Allow updating to an unresolved parent reference and emit a validation warning | optional |
| --allow-unresolved-deps | Allow unresolved local dependency targets and emit explicit warning receipts | optional |
| --completed-at <value> | Correct the actual completion timestamp on a terminal item | optional |
| --reviewer <value> | Set reviewer | optional |
| --risk <value> | Set risk level: low|med|medium|high|critical (med persists as medium) | optional |
| --confidence <value> | Set confidence level: 0..100|low|med|medium|high (med persists as medium) | optional |
| --sprint <value> | Set sprint identifier | optional |
| --release <value> | Set release identifier | optional |
| --blocked-by <value> | Set latest blocked-by item ID or reason; resolved item IDs append a blocked_by dependency edge | optional |
| --blocked-reason <value> | Set blocked reason | optional |
| --unblock-note <value> | Set unblock rationale note | optional |
| --reporter <value> | Set issue reporter | optional |
| --severity <value> | Set issue severity: low|med|medium|high|critical (med persists as medium) | optional |
| --environment <value> | Set issue environment context | optional |
| --repro-steps <value> | Set issue reproduction steps | optional |
| --resolution <value> | Set issue resolution summary | optional |
| --expected-result <value> | Set issue expected behavior | optional |
| --expected <value> | Short alias for --expected-result | optional |
| --actual-result <value> | Set issue observed behavior | optional |
| --actual <value> | Short alias for --actual-result | optional |
| --affected-version <value> | Set affected version identifier | optional |
| --fixed-version <value> | Set fixed version identifier | optional |
| --component <value> | Set issue component ownership | optional |
| --regression [value] | Set regression marker; bare flag means true, or pass true|false|1|0 | optional |
| --customer-impact <value> | Set customer impact summary | optional |
| --dep <value> | Add dependency entries id=<id>,kind=<value>,author=<value>,created_at=<iso|now>,source_kind=<value> (repeatable) | optional |
| --dep-remove <value> | Remove by dependency id or exact row signature (repeatable) | optional |
| --comment <value> | Append comment seed author=<value>,created_at=<iso|now>,text=<value> (also accepts markdown pairs and - for stdin; repeatable) | optional |
| --note <value> | Append note seed author=<value>,created_at=<iso|now>,text=<value> (also accepts markdown pairs and - for stdin; repeatable) | optional |
| --learning <value> | Append learning seed author=<value>,created_at=<iso|now>,text=<value> (also accepts markdown pairs and - for stdin; repeatable) | optional |
| --file <value> | Append linked file path=<value>,scope=<project|global>,note=<text> (also accepts markdown pairs and - for stdin; repeatable) | optional |
| --test <value> | Append test command=<value>,path=<value>,scope=<project|global>,timeout_seconds=<n>,pm_context_mode=<schema|tracker|auto|none> (also accepts markdown pairs and - for stdin; repeatable) | optional |
| --doc <value> | Append linked doc path=<value>,scope=<project|global>,note=<text> (also accepts markdown pairs and - for stdin; repeatable) | optional |
| --reminder <value> | Set reminders at=<iso|relative>,text=<text> (also accepts markdown pairs and - for stdin; repeatable) | optional |
| --event <value> | Set events start=<iso|relative>,end=<iso|relative>,duration=<relative|30min|PT30M>,title=<text>,all_day=<true|false>,recur_* fields (also accepts markdown pairs and - for stdin; repeatable) | optional |
| --type-option <value> | Set type options key=value or key=<name>,value=<value> (also accepts key:value and markdown pairs; use - for stdin; repeatable) | optional |
| --field <name=value> | Set a field declared by an active extension registerItemFields registration (repeatable) | optional |
| --unset <field> | Clear scalar metadata field by name (repeatable) | optional |
| --stdin-json | Read a full item JSON document from stdin; explicit flags override document values | optional |
| --body-file <path> | Load body from a file or stdin (-); conflicts with --body | optional |
| --replace-deps | Atomically replace dependency entries with the provided --dep values | optional |
| --replace-tests | Atomically replace linked test entries with the provided --test values | optional |
| --replace-files | Atomically replace linked file entries with the provided --file values | optional |
| --replace-docs | Atomically replace linked doc entries with the provided --doc values | optional |
| --clear-deps | Clear dependency entries | optional |
| --clear-comments | Clear comments | optional |
| --clear-notes | Clear notes | optional |
| --clear-learnings | Clear learnings | optional |
| --clear-files | Clear linked files | optional |
| --clear-tests | Clear linked tests | optional |
| --clear-docs | Clear linked docs | optional |
| --clear-reminders | Clear reminders | optional |
| --clear-events | Clear events | optional |
| --clear-type-options | Clear type options | optional |
| --force | Force ownership override | optional |
Examples
pm update pm-a1b2 --status in_progress --message "Start implementation"