CLI
@convilyn/sdk installs a convilyn binary — the same capabilities as the SDK, from your shell.
Setup
The CLI reads your key from the environment.
export CONVILYN_API_KEY=ck_…Commands
convilyn doctor --ping # environment + backend connectivity
convilyn convert a.docx --to pdf -o a.pdf
convilyn goals start --goal-text "Summarise" --files f_123
convilyn goals status <jobSpecId> --watch
convilyn goals events <jobSpecId>
convilyn account plan
convilyn account quota --tool pdf-mcp:extract_text
convilyn api GET /api/v1/health # gh-style escape hatchPass --json to any command to emit machine-readable output.
Exit codes
Exit codes are pinned for scripting.
| Code | Meaning |
|---|---|
0 | OK |
1 | Usage error |
2 | API error |
3 | Job failed |
130 | Interrupted |