Prerequisites
- Node.js ≥ 20 — download
- A Plaud account
Install
Quick start
Command reference
Authentication
Browse
plaud files options
| Option | Description | Default |
|---|---|---|
-p, --page | Page number (1–1000) | 1 |
-s, --page-size | Items per page (10–100) | 20 |
Search
| Option | Description |
|---|---|
--from <YYYY-MM-DD> | Start of date range (inclusive) |
--to <YYYY-MM-DD> | End of date range (inclusive) |
--max <n> | Maximum results to display (default: 50) |
Read a recording
Utility
Data reference
Fields in plaud files / plaud file
| Field | Description |
|---|---|
id | Unique recording ID — use this in other commands |
name | Recording name |
created_at | Creation time (ISO 8601) |
duration | Length of the recording |
plaud file <id> only:
| Field | Description |
|---|---|
start_at | Recording start time (ISO 8601) |
serial_number | Device serial number |
audio | Whether audio is available for download |
transcript | Whether a transcript is available |
summary | Whether an AI summary is available |
Exit codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Invalid arguments or unknown error |
2 | Authentication failed — run plaud login |
3 | Network error — check your connection |
4 | Request timed out |
Configuration
Tokens are stored at~/.plaud/tokens.json and managed automatically — no manual edits needed.
For advanced use, create an optional config file at ~/.plaud/cli.yaml:
| Variable | Purpose |
|---|---|
PLAUD_API_BASE | Override the API base URL |
PLAUD_CLIENT_ID / PLAUD_CLI_CLIENT_ID | OAuth client ID |
PLAUD_CLIENT_SECRET | OAuth client secret |
PLAUD_AUTH_URL | Authorization endpoint |
PLAUD_TOKEN_URL | Token exchange endpoint |
PLAUD_REFRESH_URL | Token refresh endpoint |
Upgrade
Uninstall
Troubleshooting
| Symptom | Fix |
|---|---|
401 / “Not authenticated” | Run plaud login |
plaud: command not found | Reopen your terminal; confirm npm install -g @plaud-ai/cli completed without errors |
| Token refresh errors | Delete ~/.plaud/tokens.json and run plaud login again |
| Browser doesn’t open during sign-in | Copy the URL printed in the terminal and open it manually |
npx returns E404 for @plaud-ai/cli | Run npm cache clean --force and retry |