Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.9.0] - 2026-06-04

### Added

- **Help Scout Docs API support** — a new `hscli docs` command group for the knowledge base. Docs is a separate product and authenticates with its own per-user API key, independent of the Mailbox OAuth login:
- `docs auth` — validate and store the Docs API key in the OS keychain (or pass `HSCLI_DOCS_API_KEY` for CI).
- **Read & search:** `docs site list|get`, `docs collection list|get`, `docs category list`, `docs article list|get|search`.
- **Articles:** `docs article create|update|delete`, plus `docs article save-draft|delete-draft`.
- **Collections & categories:** `docs collection create|update|delete`, `docs category create|update|delete`.
- The Docs client is host-locked to `docsapi.helpscout.net` and shares hscli's retry/backoff, rate-limit handling, structured `--output table|json|yaml|csv`, and deterministic exit codes.
- Documentation: a new **Docs (knowledge base)** guide, separate-API-key coverage in the authentication guide, and a home-page recipe showing an agent turning inbox patterns into published articles. The generated command reference now spans all 88 commands.

## [0.8.1] - 2026-06-04

### Changed
Expand Down
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@
Command-line interface for [Help Scout](https://www.helpscout.com/).

Covers the **Mailbox API 2.0** (conversations, customers, mailboxes, users, tags,
workflows, webhooks, reports) plus **Beacon** HMAC/snippet utilities and a full
account **backup**. Docs API support is planned.
workflows, webhooks, reports) and the **Docs API** (knowledge base: sites, collections,
categories, articles, search), plus **Beacon** HMAC/snippet utilities and a full
account **backup**.

JSON output, deterministic exit codes, and a raw `hscli api` escape hatch make it
a clean way to drive Help Scout from CI pipelines and **AI agents** (Claude Code,
Expand Down Expand Up @@ -46,6 +47,10 @@ hscli conv list # List conversations
hscli conv reply 123 --body "Thanks" # Reply to a conversation
hscli customer create --email user@example.com --first Jane
hscli backup --out ~/hs-backup # Full account backup (incremental on re-run)

# Docs knowledge base (separate per-user API key: `hscli docs auth` or HSCLI_DOCS_API_KEY)
hscli docs auth # Store your Docs API key in the keychain
hscli docs article search "refund" # Search the knowledge base
```

For CI/CD, use the non-interactive client-credentials flow:
Expand All @@ -68,6 +73,7 @@ HSCLI_APP_ID=... HSCLI_APP_SECRET=... hscli auth login --client-credentials
| `hscli webhook` | `list`, `get`, `create`, `delete` |
| `hscli report` | `company`, `user`, `conversations`, `beacon` |
| `hscli beacon` | `sign`, `verify`, `embed`, `identify-snippet` — HMAC + snippet utilities for Beacon Secure Mode |
| `hscli docs` | `auth`, `site`, `collection`, `category`, `article` — read/search + full CRUD on collections, categories & articles (incl. drafts) in the Docs knowledge base (separate per-user API key) |
| `hscli profile` | `list`, `use`, `current` |
| `hscli config` | `get`, `set`, `list`, `validate` |
| `hscli alias` | `set`, `list`, `unset` — custom command shortcuts |
Expand Down
Loading
Loading