CLI overview

The Ploid CLI is a focused command-line client for the public API. It supports macOS and Linux with Node.js 20 or newer.

Install

curl https://ploid.com/install -fsS | bash

The URL installer is the supported distribution channel for the CLI.

Log in

ploid login
ploid status

ploid login opens a device authorization flow and stores a scoped credential locally. On a headless machine:

ploid login --no-browser

For CI, set PLOID_API_KEY instead.

Search and enrich

ploid search "AI security founders in San Francisco" --limit 25 --type auto
ploid enrich https://www.linkedin.com/in/example --fields work_email,phone
ploid socials --github octocat

--title, --company, and --location are hard filters. A person who contradicts one is not returned. Matching rules are on the search command page and the API hard filters section.

People Sets (preview) are available through the API, not the CLI.

Machine-readable mode

Put global flags before the command.

ploid --json search "revenue leaders at developer-tool startups"
ploid --json usage

Update or remove credentials

ploid update
ploid logout

See the command index for every top-level command, or open a workflow page for focused examples and limits.