hscli — Help Scout from your terminal
Search docs ⌘K
Open source · Help Scout CLI Help Scout,<br>from your terminal.<br>A fast, scriptable CLI for Help Scout — built for terminals, CI pipelines, and AI agents like Claude Code and Codex. Every command speaks JSON and returns clean exit codes.<br>Get started
Star on GitHub
$npm i -g @wavyx/hscli
zsh — hscli<br>$ hscli conv list --status active --output table<br>ID SUBJECT CUSTOMER STATUS<br>4831 Refund for order #2207 amir@acme.io active<br>4830 Can't reset my password lou@hey.com active<br>4827 Invoice question kai@studio.co active
$ # close everything tagged "resolved"<br>$ hscli conv bulk-status --status active --tag resolved \<br>--set closed --yes<br>✓ 12 conversations closed · exit 0
Why hscli<br>Built for automation, not clicking.<br>Four design decisions that make hscli safe to hand to a script — or an agent.
Agent & workflow ready<br>JSON output, deterministic exit codes, and a raw hscli api hatch let agents and pipelines drive Help Scout directly.
Pipe-friendly output<br>Every command supports --output table|json|yaml|csv, plus --jq and --fields for inline filtering and projection.
Secure by default<br>OAuth tokens live only in your OS keychain — never written to disk in plaintext. hscli api is locked to the Help Scout host.
Full account backups<br>hscli backup dumps your whole account to JSON with incremental refresh, resume, deletion detection, and attachments.
What you can actually do<br>Real work, one line at a time.<br>hscli composes with the tools you already use — jq, xargs, cron, and your CI runner.
Triage Let an agent clear the queue<br>Pipe active conversations into your model and act on its decisions — no integration code.
$ hscli conv list --status active \<br>--output json --fields id,subject \<br>| claude -p "tag & assign each"
Backup Nightly account snapshot in CI<br>Incremental by default, resumable, and deletion-aware. Drop it in a cron job or a GitHub Action.
# .github/workflows/backup.yml<br>$ hscli backup --out ./hs-data \<br>--attachments --compress<br>✓ 4,210 convs · 38 MB · exit 0
Report Pull metrics into a spreadsheet<br>Stream any report as CSV and pipe it straight into your BI tool or a Google Sheet.
$ hscli report conversations \<br>--start 2026-05-01 --end 2026-05-31 \<br>--output csv > may.csv
Drive Help Scout from anywhere.<br>Install once. Script everything. Hand the rest to an agent.<br>Read the guide<br>Command reference
Esc<br>Try conv list, backup, or authentication