---
title: "plm reports"
description: "Reports and analytics exports"
---

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

Reports and analytics exports

**Usage**

```bash
plm reports
```

**Subcommands**

- [`bom-cost-analysis`](#plm-reports-bom-cost-analysis)
- [`bom-cost-comparison`](#plm-reports-bom-cost-comparison)
- [`bom-what-if-analysis`](#plm-reports-bom-what-if-analysis)
- [`lifecycle-report`](#plm-reports-lifecycle-report)
- [`change-history-report`](#plm-reports-change-history-report)
- [`change-period-comparison`](#plm-reports-change-period-comparison)
- [`bom-cost-trends`](#plm-reports-bom-cost-trends)
- [`lifecycle-analytics`](#plm-reports-lifecycle-analytics)
- [`lifecycle-aging`](#plm-reports-lifecycle-aging)
- [`change-analytics`](#plm-reports-change-analytics)
- [`lifecycle-transitions`](#plm-reports-lifecycle-transitions)
- [`item-change-history`](#plm-reports-item-change-history)
- [`custom`](#plm-reports-custom) — Custom reports
- [`templates`](#plm-reports-templates) — Report templates

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

```json
{
  "command": "plm reports",
  "description": "Reports and analytics exports",
  "arguments": [],
  "options": [],
  "subcommands": [
    "bom-cost-analysis",
    "bom-cost-comparison",
    "bom-what-if-analysis",
    "lifecycle-report",
    "change-history-report",
    "change-period-comparison",
    "bom-cost-trends",
    "lifecycle-analytics",
    "lifecycle-aging",
    "change-analytics",
    "lifecycle-transitions",
    "item-change-history",
    "custom",
    "templates"
  ]
}
```

</details>

### plm reports bom-cost-analysis

**Usage**

```bash
plm reports bom-cost-analysis
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports bom-cost-analysis",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports bom-cost-comparison

**Usage**

```bash
plm reports bom-cost-comparison
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports bom-cost-comparison",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports bom-what-if-analysis

**Usage**

```bash
plm reports bom-what-if-analysis
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports bom-what-if-analysis",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports lifecycle-report

**Usage**

```bash
plm reports lifecycle-report
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports lifecycle-report",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports change-history-report

**Usage**

```bash
plm reports change-history-report
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports change-history-report",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports change-period-comparison

**Usage**

```bash
plm reports change-period-comparison
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports change-period-comparison",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports bom-cost-trends

**Usage**

```bash
plm reports bom-cost-trends <bomId>
```

**Options**

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

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

```json
{
  "command": "plm reports bom-cost-trends",
  "description": null,
  "arguments": [
    {
      "name": "bomId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports lifecycle-analytics

**Usage**

```bash
plm reports lifecycle-analytics <organizationId>
```

**Options**

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

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

```json
{
  "command": "plm reports lifecycle-analytics",
  "description": null,
  "arguments": [
    {
      "name": "organizationId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports lifecycle-aging

**Usage**

```bash
plm reports lifecycle-aging <organizationId>
```

**Options**

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

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

```json
{
  "command": "plm reports lifecycle-aging",
  "description": null,
  "arguments": [
    {
      "name": "organizationId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports change-analytics

**Usage**

```bash
plm reports change-analytics <organizationId>
```

**Options**

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

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

```json
{
  "command": "plm reports change-analytics",
  "description": null,
  "arguments": [
    {
      "name": "organizationId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports lifecycle-transitions

**Usage**

```bash
plm reports lifecycle-transitions <itemId>
```

**Options**

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

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

```json
{
  "command": "plm reports lifecycle-transitions",
  "description": null,
  "arguments": [
    {
      "name": "itemId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports item-change-history

**Usage**

```bash
plm reports item-change-history <itemId>
```

**Options**

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

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

```json
{
  "command": "plm reports item-change-history",
  "description": null,
  "arguments": [
    {
      "name": "itemId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports custom

Custom reports

**Usage**

```bash
plm reports custom
```

**Subcommands**

- [`create`](#plm-reports-custom-create)
- [`list`](#plm-reports-custom-list)
- [`execute`](#plm-reports-custom-execute)
- [`export`](#plm-reports-custom-export)
- [`update`](#plm-reports-custom-update)
- [`delete`](#plm-reports-custom-delete)

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

```json
{
  "command": "plm reports custom",
  "description": "Custom reports",
  "arguments": [],
  "options": [],
  "subcommands": [
    "create",
    "list",
    "execute",
    "export",
    "update",
    "delete"
  ]
}
```

</details>

#### plm reports custom create

**Usage**

```bash
plm reports custom create
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports custom create",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

#### plm reports custom list

**Usage**

```bash
plm reports custom list <organizationId>
```

**Options**

- `-f, --filter <kv...>` — key=value filters
- `--format <fmt>` — output format _(default: `"json"`)_

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

```json
{
  "command": "plm reports custom list",
  "description": null,
  "arguments": [
    {
      "name": "organizationId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "-f, --filter <kv...>",
      "description": "key=value filters",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

#### plm reports custom execute

**Usage**

```bash
plm reports custom execute <reportId>
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports custom execute",
  "description": null,
  "arguments": [
    {
      "name": "reportId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

#### plm reports custom export

**Usage**

```bash
plm reports custom export <reportId>
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports custom export",
  "description": null,
  "arguments": [
    {
      "name": "reportId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

#### plm reports custom update

**Usage**

```bash
plm reports custom update <reportId>
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports custom update",
  "description": null,
  "arguments": [
    {
      "name": "reportId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

#### plm reports custom delete

**Usage**

```bash
plm reports custom delete <reportId>
```

**Options**

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

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

```json
{
  "command": "plm reports custom delete",
  "description": null,
  "arguments": [
    {
      "name": "reportId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reports templates

Report templates

**Usage**

```bash
plm reports templates
```

**Subcommands**

- [`list`](#plm-reports-templates-list)
- [`create-from`](#plm-reports-templates-create-from)

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

```json
{
  "command": "plm reports templates",
  "description": "Report templates",
  "arguments": [],
  "options": [],
  "subcommands": [
    "list",
    "create-from"
  ]
}
```

</details>

#### plm reports templates list

**Usage**

```bash
plm reports templates list
```

**Options**

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

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

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

</details>

#### plm reports templates create-from

**Usage**

```bash
plm reports templates create-from <templateId>
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm reports templates create-from",
  "description": null,
  "arguments": [
    {
      "name": "templateId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>