Posts
List posts
Get a post
Accepts an ID, URL, or@publication/slug:
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
Search
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:
Structured errors
In--json mode, errors are structured JSON on stderr with a non-zero exit code:
UNAUTHORIZED, FORBIDDEN, NOT_FOUND, RATE_LIMITED, SERVER_ERROR, REQUEST_FAILED, CLIENT_ERROR, UNKNOWN.
Non-interactive safety
deleterequires--yesin non-TTY environmentsloginsupports--with-tokenfor stdin piping and--tokenfor direct input- Destructive commands support
--dry-run - Set
PARAGRAPH_NON_INTERACTIVE=1orCI=trueto force CLI mode
Environment variables
| Variable | Purpose |
|---|---|
PARAGRAPH_API_KEY | API key (alternative to login) |
PARAGRAPH_API_URL | Custom API base URL |
PARAGRAPH_NON_INTERACTIVE | Set to 1 to disable TUI |
CI | Set to true to disable TUI |
Interactive TUI
Runningparagraph with no arguments launches an interactive terminal UI with menus, scrollable lists, and keyboard navigation.
The TUI is disabled automatically when:
--json,--help, or--versionflags are used- stdout is not a TTY (e.g., piped output)
CI=trueorPARAGRAPH_NON_INTERACTIVE=1is set

