---
title: "plm suppliers"
description: "Manufacturer supplier records"
---

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

Manufacturer supplier records

**Usage**

```bash
plm suppliers
```

**Subcommands**

- [`add`](#plm-suppliers-add) — Add a supplier (accepts `supplier_name` or its alias `name`)
- [`update`](#plm-suppliers-update)
- [`remove`](#plm-suppliers-remove)
- [`compare`](#plm-suppliers-compare)
- [`toggle-preferred`](#plm-suppliers-toggle-preferred)

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

```json
{
  "command": "plm suppliers",
  "description": "Manufacturer supplier records",
  "arguments": [],
  "options": [],
  "subcommands": [
    "add",
    "update",
    "remove",
    "compare",
    "toggle-preferred"
  ]
}
```

</details>

### plm suppliers add

Add a supplier (accepts `supplier_name` or its alias `name`)

**Usage**

```bash
plm suppliers add <partNumber> <mfgId>
```

**Options**

- `--file <path>` — JSON payload — required field `supplier_name` (alias: `name`), optional `supplier_part_number`, `is_preferred`, `lead_time_days`, `stock_status`, `url`, `notes`

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

```json
{
  "command": "plm suppliers add",
  "description": "Add a supplier (accepts `supplier_name` or its alias `name`)",
  "arguments": [
    {
      "name": "partNumber",
      "required": true,
      "variadic": false,
      "description": ""
    },
    {
      "name": "mfgId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--file <path>",
      "description": "JSON payload — required field `supplier_name` (alias: `name`), optional `supplier_part_number`, `is_preferred`, `lead_time_days`, `stock_status`, `url`, `notes`",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>

### plm suppliers update

**Usage**

```bash
plm suppliers update <partNumber> <mfgId> <supplierId>
```

**Options**

- `--file <path>`

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

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

</details>

### plm suppliers remove

**Usage**

```bash
plm suppliers remove <partNumber> <mfgId> <supplierId>
```

**Options**

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

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

```json
{
  "command": "plm suppliers remove",
  "description": null,
  "arguments": [
    {
      "name": "partNumber",
      "required": true,
      "variadic": false,
      "description": ""
    },
    {
      "name": "mfgId",
      "required": true,
      "variadic": false,
      "description": ""
    },
    {
      "name": "supplierId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm suppliers compare

**Usage**

```bash
plm suppliers compare <partNumber>
```

**Options**

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

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

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

</details>

### plm suppliers toggle-preferred

**Usage**

```bash
plm suppliers toggle-preferred <supplierId>
```

**Options**

- `--file <path>`

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

```json
{
  "command": "plm suppliers toggle-preferred",
  "description": null,
  "arguments": [
    {
      "name": "supplierId",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    }
  ],
  "subcommands": []
}
```

</details>