Plaude CLI

Command-line interface for Plaude.

Installation

Install Node.js 20 or newer, then install the Plaude CLI globally from npm:

npm i -g plaude

Check that it is installed:

plaude --help

Upgrade to the latest version:

plaude upgrade

The upgrade command detects whether npm, pnpm, Yarn, or Bun installed the CLI and uses the same package manager. For unusual installations, set PLAUDE_PACKAGE_MANAGER explicitly:

PLAUDE_PACKAGE_MANAGER=pnpm plaude upgrade

Login

Login against production:

plaude login

Login against a local Plaude app:

pnpm dev
plaude login \
  --app-url http://localhost:3000 \
  --api-url http://localhost:3000/api/v1

The login command opens Plaude in your browser, completes device authorization, and stores the resulting credentials locally at:

~/.plaude/config.json

Auth Commands

Show the current login:

plaude whoami

Remove the local token:

plaude logout

Resource Commands

List the active organization for the current token:

plaude organizations list
plaude organizations list --format json
plaude organizations list --format csv

Manage agents:

plaude agents list
plaude agents get <agent-id>
plaude agents create --name Leo --gender male
plaude agents update <agent-id> --name Lea --instructions "Concise and friendly"
plaude agents delete <agent-id>

List customers:

plaude customers list
plaude customers list --query alice
plaude customers list --limit 50
plaude customers list --cursor <cursor>
plaude customers list --format json
plaude customers list --format csv

Get one customer:

plaude customers get <customer-id>
plaude customers get <customer-id> --format json
plaude customers get <customer-id> --format csv

List conversations:

plaude conversations list
plaude conversations list --status open
plaude conversations list --from 2026-01-01 --to 2026-01-31
plaude conversations list --status open --channel whatsapp
plaude conversations list --columns id,channel,lastActivityAt,summary
plaude conversations list --columns all
plaude conversations list --status closed --limit 50
plaude conversations list --cursor <cursor>
plaude conversations list --format json
plaude conversations list --format csv

List messages for a conversation:

plaude messages list <conversation-id>
plaude messages list <conversation-id> --limit 100
plaude messages list <conversation-id> --format json
plaude messages list <conversation-id> --format csv

Message parts mirror the inbox, in their original order:

• text, file, audio, and quote carry message content.
• procedure (id, title, content) is a procedure the agent read.
• knowledge (id, title, content) is a knowledge resource the agent read, such as an article, page, file, website, or memory.
• action (title, input, output) is an action the agent ran.
• internal_note wraps the text, file, audio, and quote content of an internal message, keeping its original fields, for example { "type": "internal_note", "text": "..." }. Procedures, knowledge, and actions keep their own types.

Table and CSV output list action, procedure, and knowledge titles in the Actions, Procedures, and Knowledge columns; --format json returns the full parts.

List participants for a conversation:

plaude conversation-participants list <conversation-id>
plaude conversation-participants list <conversation-id> --role assignee
plaude conversation-participants list <conversation-id> --participant-type customer
plaude conversation-participants list <conversation-id> --format json
plaude conversation-participants list <conversation-id> --format csv

List recurring issues for procedure coverage analysis:

plaude issues list
plaude issues list --from 2026-09-20 --to 2026-09-20
plaude issues list --query refund
plaude issues list --format json
plaude issues list --format csv

List conversations related to a recurring issue:

plaude issues conversations <issue-id>
plaude issues conversations <issue-id> --limit 50
plaude issues conversations <issue-id> --format json
plaude issues conversations <issue-id> --format csv

Query aggregated metrics (CSAT, closed conversations, first response time, sentiment, and more):

plaude metrics list
plaude metrics get closed_conversations --from 2026-09-01 --to 2026-09-07
plaude metrics get closed_conversations --breakdown teammate --bucket day
plaude metrics get total_conversations --bucket day --channel whatsapp
plaude metrics get csat --compare
plaude metrics get time_to_first_response --aggregation median --format json

List procedures for content analysis:

plaude procedures list --agent <agent-id>
plaude procedures list --agent <agent-id> --status active
plaude procedures list --agent <agent-id> --query refund
plaude procedures list --agent <agent-id> --format json
plaude procedures list --agent <agent-id> --format csv

Create, update, and delete procedures:

plaude procedures create --agent <agent-id> --title "Refunds" --content-file ./refunds.md
plaude procedures get <procedure-id> --agent <agent-id>
plaude procedures update <procedure-id> --agent <agent-id> --title "Refund policy" --content "1. Check the order\n2. Issue the refund"
plaude procedures delete <procedure-id> --agent <agent-id>

List knowledge resources for content analysis:

plaude knowledge list --agent <agent-id>
plaude knowledge list --agent <agent-id> --type memory
plaude knowledge list --agent <agent-id> --status paused
plaude knowledge list --agent <agent-id> --format json
plaude knowledge list --agent <agent-id> --format csv
plaude knowledge get <knowledge-id> --agent <agent-id>

List actions for tool coverage analysis:

plaude actions list --agent <agent-id>
plaude actions list --agent <agent-id> --query transaction
plaude actions list --agent <agent-id> --format json
plaude actions list --agent <agent-id> --format csv

Formatted Output

Most resource commands support --format with table, json, or csv:

plaude customers list --format json
plaude conversations list --format csv
plaude messages list <conversation-id> --format json
plaude issues list --format json
plaude procedures list --format csv
plaude knowledge list --agent <agent-id> --format json
plaude actions list --agent <agent-id> --format csv

Notes

Resource commands use https://api.plaude.com/v1. Browser-based device authorization uses https://plaude.com.

The CLI is distributed as JavaScript through npm and requires Node.js 20 or newer. It does not install a native executable.

Generated files in dist/ are build output and should not be edited directly.

Package Verification

Build and inspect the npm package contents:

pnpm --filter plaude build
pnpm --filter plaude exec npm pack --dry-run --json