CLI Reference
Install: npm install -g @parel/cli (Node.js >= 22)
# parel login
Log in with an API key. You can get one from Console → Settings.
parel login # API key: pk_your_key_here # Logged in. https://api.parel.sh pk_your...here # Check status parel whoami
# parel config
parel config set --server https://api.parel.sh --key pk_your_key parel config show
# parel deploy
Deploy an agent from a YAML config file. Re-deploying the same name updates that agent and adds a new version.
parel deploy agent.yaml # Deployed: my-agent v1 agt_a1B2c3D4e5F6 # Re-deploy the same name to update it (adds a new version): parel deploy agent.yaml # Deployed: my-agent v2 agt_a1B2c3D4e5F6
# parel send
Send a message to a new or existing session, optionally waiting for the result.
parel send --agent agt_abc123 --message "Summarize this repo" parel send --session <session-id> --stdin parel send --agent agt_abc123 --message "Start the job" --async parel send --agent agt_abc123 --message "Return JSON" --json
# parel run
Deploy an agent, create a session, send a message, and wait for the response.
parel run agent.yaml --message "What's trending today?" parel run agent.yaml --stdin --require-ready --timeout 180
# parel agents
parel agents list # List all agents parel agents list --json # JSON output parel agents get my-agent # Agent details (by name or id) parel agents update agt_abc123 --file agent.yaml parel agents rename my-agent new-name parel agents delete my-agent
# parel versions / rollback
Browse an agent's version history and roll back to a previous version without redeploying.
parel versions list my-agent # version history parel deployments list my-agent # deploy / rollback timeline parel rollback my-agent # roll back to the previously live version parel rollback my-agent --to v1 # roll back to a specific version
# parel sessions
parel sessions list parel sessions list --agent agt_abc123 --status running parel sessions create agt_abc123 parel sessions get <session-id> parel sessions messages <session-id>
# parel chat
Streaming interactive chat over WebSocket. Creates a new session or resumes an existing one.
# New session parel chat --agent agt_abc123 # Resume session parel chat --session <session-id> # Inside chat: $ hello ▸ Hi! How can I help? $ /messages # show conversation log $ /quit # exit
# parel logs
Show the events and logs for a session.
parel logs <session-id>
# parel steer
Redirect a session midway through execution.
parel steer --session <session-id> "Focus on AI posts only"
# parel api-keys
parel api-keys list parel api-keys create my-key parel api-keys delete key_abc123
# parel provider-keys
Manage BYOK credentials for model providers and compatible endpoint IDs.
parel provider-keys list parel provider-keys set anthropic --from-env ANTHROPIC_API_KEY parel provider-keys set groq --from-env GROQ_API_KEY parel provider-keys unset anthropic parel provider-keys delete pvk_abc123
# parel secrets
Named values referenced as ${NAME} in agent.yaml. Org-scoped by default; --agent scopes a value to a single agent (overriding the org). parel deploy also auto-uploads referenced values from your local environment; this is the place to set values you want to share or that shouldn't depend on CI env.
parel secrets list parel secrets set E2B_API_KEY # reads $E2B_API_KEY parel secrets set GH_TOKEN --from-env GITHUB_TOKEN parel secrets set E2B_API_KEY --agent agt_abc123 parel secrets unset E2B_API_KEY
# parel capabilities
Discover requirements and check whether an agent config is ready to run.
parel capabilities list parel capabilities explain sandbox.e2b parel capabilities setup model.anthropic --from-env ANTHROPIC_API_KEY parel capabilities doctor agent.yaml
# parel billing
parel billing summary parel billing balance
# Global Options
| Flag | Description |
|---|---|
| --server <url> | Override the API server URL |
| --json | Machine-readable JSON output (list commands) |
| PAREL_JSON=1 | Use machine-readable JSON output for all commands |
| PAREL_API_KEY | Override the API key without writing ~/.parel/config.json |