Skip to content

CLI quickstart

The plm CLI is the same surface as the dashboard — every action you can take in the UI has a CLI verb. Install it once and you can drive simple-plm from your terminal, your CI, or an AI agent.

Install

macOS / Linux:

Terminal window
curl -fsSL https://simple-plm.com/install.sh | sh

Windows (PowerShell):

Terminal window
iwr https://simple-plm.com/install.ps1 | iex

Both installers drop the binary at ~/.local/bin/plm (or %LOCALAPPDATA%\plm\plm.exe on Windows). Make sure that path is on your PATH.

Verify:

Terminal window
plm --version

Sign in

Terminal window
plm login

This opens your browser to https://simple-plm.com/login?cli=1. Complete Google sign-in. The browser hands a short-lived auth code back to the CLI, which exchanges it for a long-lived credential stored at ~/.config/plm/credentials (%APPDATA%\plm\credentials on Windows).

Confirm you’re authenticated:

Terminal window
plm orgs list

You should see at least one org row.

Your first read

Pipe through jq for an agent-friendly first taste:

Terminal window
plm parts list --format json | jq '.[0]'

You’ll get a JSON object for the first part in your active org. If the list is empty, walk through Your first part in the dashboard first.

Where next