---
title: "plm bi"
description: "BI read-only API (requires BI API key)"
---

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

BI read-only API (requires BI API key)

**Usage**

```bash
plm bi
```

**Subcommands**

- [`docs`](#plm-bi-docs)
- [`parts`](#plm-bi-parts)
- [`boms`](#plm-bi-boms)
- [`stats`](#plm-bi-stats)
- [`changes`](#plm-bi-changes)
- [`bom-items`](#plm-bi-bom-items)
- [`parts-stream`](#plm-bi-parts-stream)

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

```json
{
  "command": "plm bi",
  "description": "BI read-only API (requires BI API key)",
  "arguments": [],
  "options": [],
  "subcommands": [
    "docs",
    "parts",
    "boms",
    "stats",
    "changes",
    "bom-items",
    "parts-stream"
  ]
}
```

</details>

### plm bi docs

**Usage**

```bash
plm bi docs
```

**Options**

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

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

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

</details>

### plm bi parts

**Usage**

```bash
plm bi parts
```

**Options**

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

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

```json
{
  "command": "plm bi parts",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "-f, --filter <kv...>",
      "description": "key=value query params",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm bi boms

**Usage**

```bash
plm bi boms
```

**Options**

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

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

```json
{
  "command": "plm bi boms",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "-f, --filter <kv...>",
      "description": "key=value query params",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm bi stats

**Usage**

```bash
plm bi stats
```

**Options**

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

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

```json
{
  "command": "plm bi stats",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "-f, --filter <kv...>",
      "description": "key=value query params",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm bi changes

**Usage**

```bash
plm bi changes
```

**Options**

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

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

```json
{
  "command": "plm bi changes",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "-f, --filter <kv...>",
      "description": "key=value query params",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm bi bom-items

**Usage**

```bash
plm bi bom-items <bomId>
```

**Options**

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

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

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

</details>

### plm bi parts-stream

**Usage**

```bash
plm bi parts-stream
```

**Options**

- `-f, --filter <kv...>`

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

```json
{
  "command": "plm bi parts-stream",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "-f, --filter <kv...>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>