Skip to main content

Posts

List posts

Get a post

Accepts an ID, URL, or @publication/slug:
Extract a single field (raw value to stdout, pipeable):

Create a post

Creates a draft by default:

Update a post

Post lifecycle

Preview and test

Delete a post

Browse posts

Shortcuts

Top-level shortcuts for common operations:

Publications

Subscribers

Coins

Users

Agent and programmatic usage

The CLI is designed for use by AI agents and scripts.

JSON output

All commands support --json. Data goes to stdout, status messages to stderr:
Paginated commands return:
Single-item commands return the object directly:

Structured errors

In --json mode, errors are structured JSON on stderr with a non-zero exit code:
Error codes: UNAUTHORIZED, FORBIDDEN, NOT_FOUND, RATE_LIMITED, SERVER_ERROR, REQUEST_FAILED, CLIENT_ERROR, UNKNOWN.

Non-interactive safety

  • delete requires --yes in non-TTY environments
  • login supports --with-token for stdin piping and --token for direct input
  • Destructive commands support --dry-run
  • Set PARAGRAPH_NON_INTERACTIVE=1 or CI=true to force CLI mode

Environment variables

Interactive TUI

Running paragraph with no arguments launches an interactive terminal UI with menus, scrollable lists, and keyboard navigation. The TUI is disabled automatically when:
  • --json, --help, or --version flags are used
  • stdout is not a TTY (e.g., piped output)
  • CI=true or PARAGRAPH_NON_INTERACTIVE=1 is set