Plaude CLI

Command-line interface for Plaude.

Installation

Install the Plaude CLI globally:

npm i -g plaude

Check that it is installed:

plaude --help

Upgrade to the latest version:

plaude upgrade

Login

Login against production:

plaude login

Login against a local Plaude app:

pnpm dev
plaude login --base-url http://localhost:3000

The login command opens Plaude in your browser, starts a temporary localhost callback server, exchanges the authorization code for a Plaude API key, and stores it 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 --personality "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

List recurring issues for procedure coverage analysis:

plaude issues list
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

List procedures for content analysis:

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

Create, update, and delete procedures:

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

List knowledge resources for content analysis:

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

List actions for tool coverage analysis:

plaude actions list
plaude actions list --agent <agent-id>
plaude actions list --query transaction
plaude actions list --format json
plaude actions list --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 --format json
plaude actions list --format csv

Notes

The CLI token is organization-scoped. Because of that, organizations list currently returns the active organization for the stored token, not every organization the browser user can access.

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