Quickstart - Paragraph
Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
The Paragraph CLI is a command-line tool for managing posts, publications, subscribers, and coins. It works for both human and programmatic (agent) usage.
Prerequisites:
- Node.js version 18 or higher
Install
npm
npm install -g @paragraph-com/cli
Homebrew
brew tap paragraph-xyz/tap && brew install paragraph
Authentication
Get your API key from paragraph.com/settings -> Publication -> Developer.
- Authenticate
paragraph login
Or provide the key directly:
paragraph login --token <your-api-key>
- Verify
paragraph whoami
For CI or agent environments, you can pipe the token or set an environment variable:
echo "<your-api-key>" | paragraph login --with-token
PARAGRAPH_API_KEY=<your-api-key> paragraph post list
Credentials are stored in ~/.paragraph/config.json (mode 0600).
Quick examples
paragraph post create --title "My Post" --file ./draft.md
paragraph post publish my-post
paragraph post list
paragraph search post --query "ethereum"
Run paragraph --help for all commands, or paragraph <command> --help for details on any command.
Agent skill
Using an AI agent like Claude Code or Cursor? Install the Paragraph CLI skill to teach it how to use the CLI:
npx skills add paragraph-xyz/skill --skill paragraph-cli
Resources
[Full command reference
Browse all CLI commands with examples and options.](https://paragraph.com/docs/development/cli/commands)
[View on GitHub
Explore the source code or report issues.](https://github.com/paragraph-xyz/paragraph-cli)