CLI
Errors & rate limits
Handle CLI exit codes, request timeouts, machine-readable failures, and API limits.
Exit codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Invalid local input or an unexpected local failure |
2 | The Ploid API returned an error |
3 | Authentication is missing |
Use the exit code for shell control flow. In --json mode, parse the error payload and preserve its request ID for support.
Global flags
Global flags go before the command.
| Flag | Purpose |
|---|---|
--api-key <key> | Override the environment and saved credential |
--base-url <url> | Override https://api.ploid.com |
--json | Emit machine-readable JSON |
--quiet | Suppress progress output |
--timeout <seconds> | Set the client deadline; 0 disables it |
-v, --version | Print the installed version |
The default client timeout is 90 seconds. Changing it does not raise a server deadline or API budget.
Retry safely
- Respect
Retry-Afteron a429 rate_limitedresponse. - Retry
429and transient5xxfailures with bounded exponential backoff and jitter. - Do not retry invalid input, missing scopes, or exhausted budgets without changing the request or credential.
- The CLI does not automatically retry commands for you.
The underlying API has organization, API-key, and selected route-specific buckets. See the exact API plan and route limits.