Skip to content

plm workflows

plm workflows

Approval workflows

Usage

Terminal window
plm workflows

Subcommands

Agent-readable summary
{
"command": "plm workflows",
"description": "Approval workflows",
"arguments": [],
"options": [],
"subcommands": [
"templates",
"instances",
"delegations",
"overdue"
]
}

plm workflows templates

Workflow templates

Usage

Terminal window
plm workflows templates

Subcommands

  • list — List all workflow templates
  • get — Get a workflow template by template ID
  • create — Create a new workflow template
  • update — Update an existing workflow template by template ID
Agent-readable summary
{
"command": "plm workflows templates",
"description": "Workflow templates",
"arguments": [],
"options": [],
"subcommands": [
"list",
"get",
"create",
"update"
]
}

plm workflows templates list

List all workflow templates

Usage

Terminal window
plm workflows templates list

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm workflows templates list",
"description": "List all workflow templates",
"arguments": [],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm workflows templates get

Get a workflow template by template ID

Usage

Terminal window
plm workflows templates get <id>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm workflows templates get",
"description": "Get a workflow template by template ID",
"arguments": [
{
"name": "id",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm workflows templates create

Create a new workflow template

Usage

Terminal window
plm workflows templates create

Options

  • --file <path> — JSON/YAML file with the template payload (name, stages, reviewers, etc.)
Agent-readable summary
{
"command": "plm workflows templates create",
"description": "Create a new workflow template",
"arguments": [],
"options": [
{
"flags": "--file <path>",
"description": "JSON/YAML file with the template payload (name, stages, reviewers, etc.)",
"required": false,
"default": null
}
],
"subcommands": []
}

plm workflows templates update

Update an existing workflow template by template ID

Usage

Terminal window
plm workflows templates update <id>

Options

  • --file <path> — JSON/YAML file with the fields to update (partial update; only included keys are changed)
Agent-readable summary
{
"command": "plm workflows templates update",
"description": "Update an existing workflow template by template ID",
"arguments": [
{
"name": "id",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--file <path>",
"description": "JSON/YAML file with the fields to update (partial update; only included keys are changed)",
"required": false,
"default": null
}
],
"subcommands": []
}

plm workflows instances

Workflow instances

Usage

Terminal window
plm workflows instances

Subcommands

  • create — Start a new workflow instance from a template
  • get — Get a workflow instance by instance ID
  • approve — Approve a pending workflow instance
  • reject — Reject a pending workflow instance
  • escalate — Escalate a workflow instance to the next reviewer tier
  • resolve-conflict — Resolve a merge conflict blocking a workflow instance
  • history — List the state-transition history for a workflow instance
  • branch-status — Show the git branch status tied to a workflow instance
Agent-readable summary
{
"command": "plm workflows instances",
"description": "Workflow instances",
"arguments": [],
"options": [],
"subcommands": [
"create",
"get",
"approve",
"reject",
"escalate",
"resolve-conflict",
"history",
"branch-status"
]
}

plm workflows instances create

Start a new workflow instance from a template

Usage

Terminal window
plm workflows instances create

Options

  • --file <path> — JSON/YAML file with the instance payload (template_id, target entity, initial state, etc.)
Agent-readable summary
{
"command": "plm workflows instances create",
"description": "Start a new workflow instance from a template",
"arguments": [],
"options": [
{
"flags": "--file <path>",
"description": "JSON/YAML file with the instance payload (template_id, target entity, initial state, etc.)",
"required": false,
"default": null
}
],
"subcommands": []
}

plm workflows instances get

Get a workflow instance by instance ID

Usage

Terminal window
plm workflows instances get <id>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm workflows instances get",
"description": "Get a workflow instance by instance ID",
"arguments": [
{
"name": "id",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm workflows instances approve

Approve a pending workflow instance

Usage

Terminal window
plm workflows instances approve <id>

Options

  • --file <path> — Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)
Agent-readable summary
{
"command": "plm workflows instances approve",
"description": "Approve a pending workflow instance",
"arguments": [
{
"name": "id",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--file <path>",
"description": "Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)",
"required": false,
"default": null
}
],
"subcommands": []
}

plm workflows instances reject

Reject a pending workflow instance

Usage

Terminal window
plm workflows instances reject <id>

Options

  • --file <path> — Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)
Agent-readable summary
{
"command": "plm workflows instances reject",
"description": "Reject a pending workflow instance",
"arguments": [
{
"name": "id",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--file <path>",
"description": "Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)",
"required": false,
"default": null
}
],
"subcommands": []
}

plm workflows instances escalate

Escalate a workflow instance to the next reviewer tier

Usage

Terminal window
plm workflows instances escalate <id>

Options

  • --file <path> — Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)
Agent-readable summary
{
"command": "plm workflows instances escalate",
"description": "Escalate a workflow instance to the next reviewer tier",
"arguments": [
{
"name": "id",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--file <path>",
"description": "Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)",
"required": false,
"default": null
}
],
"subcommands": []
}

plm workflows instances resolve-conflict

Resolve a merge conflict blocking a workflow instance

Usage

Terminal window
plm workflows instances resolve-conflict <id>

Options

  • --file <path> — Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)
Agent-readable summary
{
"command": "plm workflows instances resolve-conflict",
"description": "Resolve a merge conflict blocking a workflow instance",
"arguments": [
{
"name": "id",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--file <path>",
"description": "Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)",
"required": false,
"default": null
}
],
"subcommands": []
}

plm workflows instances history

List the state-transition history for a workflow instance

Usage

Terminal window
plm workflows instances history <id>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm workflows instances history",
"description": "List the state-transition history for a workflow instance",
"arguments": [
{
"name": "id",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm workflows instances branch-status

Show the git branch status tied to a workflow instance

Usage

Terminal window
plm workflows instances branch-status <id>

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm workflows instances branch-status",
"description": "Show the git branch status tied to a workflow instance",
"arguments": [
{
"name": "id",
"required": true,
"variadic": false,
"description": ""
}
],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm workflows delegations

Workflow delegations

Usage

Terminal window
plm workflows delegations

Subcommands

  • list — List all active workflow delegations
  • create — Create a workflow delegation (assign a reviewer’s approvals to a delegate)
Agent-readable summary
{
"command": "plm workflows delegations",
"description": "Workflow delegations",
"arguments": [],
"options": [],
"subcommands": [
"list",
"create"
]
}

plm workflows delegations list

List all active workflow delegations

Usage

Terminal window
plm workflows delegations list

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm workflows delegations list",
"description": "List all active workflow delegations",
"arguments": [],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}

plm workflows delegations create

Create a workflow delegation (assign a reviewer’s approvals to a delegate)

Usage

Terminal window
plm workflows delegations create

Options

  • --file <path> — JSON/YAML file with the delegation payload (from_user, to_user, scope, expires_at)
Agent-readable summary
{
"command": "plm workflows delegations create",
"description": "Create a workflow delegation (assign a reviewer's approvals to a delegate)",
"arguments": [],
"options": [
{
"flags": "--file <path>",
"description": "JSON/YAML file with the delegation payload (from_user, to_user, scope, expires_at)",
"required": false,
"default": null
}
],
"subcommands": []
}

plm workflows overdue

List workflow instances past their SLA

Usage

Terminal window
plm workflows overdue

Options

  • --format <fmt> — output format (default: "json")
Agent-readable summary
{
"command": "plm workflows overdue",
"description": "List workflow instances past their SLA",
"arguments": [],
"options": [
{
"flags": "--format <fmt>",
"description": "output format",
"required": false,
"default": "json"
}
],
"subcommands": []
}