CLI

The Paragraph CLI covers the same ground as the REST API, with JSON output for scripts and agents and an interactive menu for everyone else.

InstallCopy Anchor Link

npm install -g @paragraph-com/cli

Sign inCopy Anchor Link

paragraph login

This opens Paragraph in your browser, where you pick the publication to connect and approve access. To use an API key instead, pass it with --token, pipe it in with --with-token, or set PARAGRAPH_API_KEY:

paragraph login --token <your-api-key>
echo "<your-api-key>" | paragraph login --with-token
PARAGRAPH_API_KEY=<your-api-key> paragraph post list

Run paragraph whoami to check which publication you're using. Credentials are stored in ~/.paragraph/config.json.

PostsCopy Anchor Link

Posts are what the app calls articles. New posts are drafts until you publish them.

paragraph post create --title "October update" --file ./draft.md
paragraph post list --status draft
paragraph post get <id-or-slug> --field markdown > post.md
paragraph post update <id-or-slug> --file ./updated.md
paragraph post publish <id-or-slug>
paragraph post publish <id-or-slug> --newsletter   # also email subscribers

post get accepts an ID, a URL, or @publication/slug. Other post commands include draft, archive, delete, test-email, feed, and by-tag, and destructive ones take --dry-run.

Drafted contentCopy Anchor Link

Short-form drafts (X posts and X threads, LinkedIn posts, one-off emails, X articles) go to the publication's library. Nothing is sent until someone approves it, in the app or with paragraph content publish and paragraph schedule approve.

paragraph content create --kind tweet --title "Launch thread" --tweet "First." --tweet "Second."
paragraph content list --kind tweet --status draft

See Drafted content for every kind, how to group drafts with the post they came from, and the content commands that edit, archive, and restore them.

AgentsCopy Anchor Link

Set up and run agents like the Changelog. A run writes drafts, and nothing goes out until your team approves it, in the app or with agent run launch.

paragraph agent list
paragraph agent get changelog   # its field and deliverable keys
paragraph agent setup changelog --repository acme/widget --value audience="Developers evaluating the SDK"
paragraph agent run start changelog
paragraph agent run get changelog <run-id>
paragraph agent run list changelog
paragraph agent run launch changelog <run-id> --start launch_now

agent setup changes only what you pass and keeps the rest of the setup. --deliverable (repeatable) replaces the list of what the agent makes. See Agent runs for what each setting does.

Publications and subscribersCopy Anchor Link

paragraph publication get @your-publication
paragraph subscriber list --limit 100
paragraph subscriber add --email reader@example.com
paragraph subscriber import --csv subscribers.csv

Run paragraph --help for every command, or paragraph <command> --help for its flags.

Scripts and agentsCopy Anchor Link

Every command takes --json. Data goes to stdout and status messages to stderr, so output pipes cleanly:

paragraph --json post list | jq '.data[0].title'

Lists return { "data": [...], "pagination": { "cursor": "...", "hasMore": true } }, and single items return the object itself. In --json mode, errors are JSON on stderr with a non-zero exit code:

{ "error": "Not found.", "code": "NOT_FOUND", "status": 404 }

code is one of UNAUTHORIZED, FORBIDDEN, NOT_FOUND, RATE_LIMITED, SERVER_ERROR, REQUEST_FAILED, CLIENT_ERROR, or UNKNOWN.

Outside a terminal, delete requires --yes. Set PARAGRAPH_NON_INTERACTIVE=1 or CI=true to turn off the interactive menu, and PARAGRAPH_API_URL to point at a different API.

To teach a coding agent the CLI, install the Paragraph CLI skill.

Interactive modeCopy Anchor Link

Run paragraph with no arguments for a menu-driven interface with scrollable lists and keyboard navigation. It's skipped automatically when output is piped or --json, --help, or --version is passed.

PackageCopy Anchor Link

The CLI is published to npm as @paragraph-com/cli.