---
title: "plm workflows"
description: "Approval workflows"
---

{/* AUTO-GENERATED by packages/cli/scripts/generate-docs.ts — do not edit by hand. */}
## plm workflows

Approval workflows

**Usage**

```bash
plm workflows
```

**Subcommands**

- [`templates`](#plm-workflows-templates) — Workflow templates
- [`instances`](#plm-workflows-instances) — Workflow instances
- [`delegations`](#plm-workflows-delegations) — Workflow delegations
- [`overdue`](#plm-workflows-overdue) — List workflow instances past their SLA

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm workflows",
  "description": "Approval workflows",
  "arguments": [],
  "options": [],
  "subcommands": [
    "templates",
    "instances",
    "delegations",
    "overdue"
  ]
}
```

</details>

### plm workflows templates

Workflow templates

**Usage**

```bash
plm workflows templates
```

**Subcommands**

- [`list`](#plm-workflows-templates-list) — List all workflow templates
- [`get`](#plm-workflows-templates-get) — Get a workflow template by template ID
- [`create`](#plm-workflows-templates-create) — Create a new workflow template
- [`update`](#plm-workflows-templates-update) — Update an existing workflow template by template ID

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm workflows templates",
  "description": "Workflow templates",
  "arguments": [],
  "options": [],
  "subcommands": [
    "list",
    "get",
    "create",
    "update"
  ]
}
```

</details>

#### plm workflows templates list

List all workflow templates

**Usage**

```bash
plm workflows templates list
```

**Options**

- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm workflows templates list",
  "description": "List all workflow templates",
  "arguments": [],
  "options": [
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

#### plm workflows templates get

Get a workflow template by template ID

**Usage**

```bash
plm workflows templates get <id>
```

**Options**

- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

#### plm workflows templates create

Create a new workflow template

**Usage**

```bash
plm workflows templates create
```

**Options**

- `--file <path>` — JSON/YAML file with the template payload (name, stages, reviewers, etc.)

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

#### plm workflows templates update

Update an existing workflow template by template ID

**Usage**

```bash
plm workflows templates update <id>
```

**Options**

- `--file <path>` — JSON/YAML file with the fields to update (partial update; only included keys are changed)

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

### plm workflows instances

Workflow instances

**Usage**

```bash
plm workflows instances
```

**Subcommands**

- [`create`](#plm-workflows-instances-create) — Start a new workflow instance from a template
- [`get`](#plm-workflows-instances-get) — Get a workflow instance by instance ID
- [`approve`](#plm-workflows-instances-approve) — Approve a pending workflow instance
- [`reject`](#plm-workflows-instances-reject) — Reject a pending workflow instance
- [`escalate`](#plm-workflows-instances-escalate) — Escalate a workflow instance to the next reviewer tier
- [`resolve-conflict`](#plm-workflows-instances-resolve-conflict) — Resolve a merge conflict blocking a workflow instance
- [`history`](#plm-workflows-instances-history) — List the state-transition history for a workflow instance
- [`branch-status`](#plm-workflows-instances-branch-status) — Show the git branch status tied to a workflow instance

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm workflows instances",
  "description": "Workflow instances",
  "arguments": [],
  "options": [],
  "subcommands": [
    "create",
    "get",
    "approve",
    "reject",
    "escalate",
    "resolve-conflict",
    "history",
    "branch-status"
  ]
}
```

</details>

#### plm workflows instances create

Start a new workflow instance from a template

**Usage**

```bash
plm workflows instances create
```

**Options**

- `--file <path>` — JSON/YAML file with the instance payload (template_id, target entity, initial state, etc.)

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

#### plm workflows instances get

Get a workflow instance by instance ID

**Usage**

```bash
plm workflows instances get <id>
```

**Options**

- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

#### plm workflows instances approve

Approve a pending workflow instance

**Usage**

```bash
plm workflows instances approve <id>
```

**Options**

- `--file <path>` — Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

#### plm workflows instances reject

Reject a pending workflow instance

**Usage**

```bash
plm workflows instances reject <id>
```

**Options**

- `--file <path>` — Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

#### plm workflows instances escalate

Escalate a workflow instance to the next reviewer tier

**Usage**

```bash
plm workflows instances escalate <id>
```

**Options**

- `--file <path>` — Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

#### plm workflows instances resolve-conflict

Resolve a merge conflict blocking a workflow instance

**Usage**

```bash
plm workflows instances resolve-conflict <id>
```

**Options**

- `--file <path>` — Optional JSON/YAML file with action-specific payload (e.g. comment, resolution body)

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

#### plm workflows instances history

List the state-transition history for a workflow instance

**Usage**

```bash
plm workflows instances history <id>
```

**Options**

- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

#### plm workflows instances branch-status

Show the git branch status tied to a workflow instance

**Usage**

```bash
plm workflows instances branch-status <id>
```

**Options**

- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

### plm workflows delegations

Workflow delegations

**Usage**

```bash
plm workflows delegations
```

**Subcommands**

- [`list`](#plm-workflows-delegations-list) — List all active workflow delegations
- [`create`](#plm-workflows-delegations-create) — Create a workflow delegation (assign a reviewer's approvals to a delegate)

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm workflows delegations",
  "description": "Workflow delegations",
  "arguments": [],
  "options": [],
  "subcommands": [
    "list",
    "create"
  ]
}
```

</details>

#### plm workflows delegations list

List all active workflow delegations

**Usage**

```bash
plm workflows delegations list
```

**Options**

- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm workflows delegations list",
  "description": "List all active workflow delegations",
  "arguments": [],
  "options": [
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

#### plm workflows delegations create

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

**Usage**

```bash
plm workflows delegations create
```

**Options**

- `--file <path>` — JSON/YAML file with the delegation payload (from_user, to_user, scope, expires_at)

<details>
<summary>Agent-readable summary</summary>

```json
{
  "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": []
}
```

</details>

### plm workflows overdue

List workflow instances past their SLA

**Usage**

```bash
plm workflows overdue
```

**Options**

- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

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

</details>