Pp Help Scout

<!-- GENERATED FILE — DO NOT EDIT.
     This file is a verbatim mirror of library/sales-and-crm/help-scout/SKILL.md,
     regenerated post-merge by tools/generate-skills/. Hand-edits here are
     silently overwritten on the next regen. Edit the library/ source instead.
     See the repository agent guide, section "Generated artifacts: registry.json, cli-skills/". -->

Help Scout — Printing Press CLI

Prerequisites: Install the CLI

This skill drives the help-scout-pp-cli binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:

1. Install via the Printing Press installer. It defaults binaries to $HOME/.local/bin on macOS/Linux and %LOCALAPPDATA%\Programs\PrintingPress\bin on Windows:

   npx -y @mvanhorn/printing-press-library install help-scout --cli-only

2. Verify: help-scout-pp-cli --version
3. Ensure the reported install directory is on $PATH for the agent/runtime that will invoke this skill.

If the npx install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.6 or newer). This installs into $GOPATH/bin (default $HOME/go/bin), so add that directory to $PATH instead:

go install github.com/mvanhorn/printing-press-library/library/sales-and-crm/help-scout/cmd/help-scout-pp-cli@latest

If --version reports "command not found" after install, the runtime cannot see the binary directory on $PATH. Do not proceed with skill commands until verification succeeds.

Read-first Help Scout Inbox API surface for support operations and agent workflows.

When Not to Use This CLI

Do not activate this CLI for requests that require creating, updating, deleting, publishing, commenting, upvoting, inviting, ordering, sending messages, booking, purchasing, or changing remote state. This printed CLI exposes read-only commands for inspection, export, sync, and analysis.

Command Reference

conversations — Manage conversations

• help-scout-pp-cli conversations get — Get a conversation by ID.
• help-scout-pp-cli conversations get-v3 — Get a conversation by ID using the v3 conversation representation.
• help-scout-pp-cli conversations list — List conversations.

customers — Manage customers

• help-scout-pp-cli customers get — Get a customer by ID.
• help-scout-pp-cli customers list — List customers.

mailboxes — Manage mailboxes

• help-scout-pp-cli mailboxes get-mailbox — Get a Help Scout mailbox by ID.
• help-scout-pp-cli mailboxes list — List Help Scout mailboxes.

reports — Manage reports

• help-scout-pp-cli reports get-conversation — Get conversation reporting metrics.
• help-scout-pp-cli reports get-happiness — Get customer happiness reporting metrics.
• help-scout-pp-cli reports get-productivity — Get productivity reporting metrics.

tags — Manage tags

• help-scout-pp-cli tags — List Help Scout tags.

teams — Manage teams

• help-scout-pp-cli teams — List Help Scout teams.

users — Manage users

• help-scout-pp-cli users get — Get a Help Scout user by ID.
• help-scout-pp-cli users get-current — Get the authenticated Help Scout user.
• help-scout-pp-cli users list — List Help Scout users.

webhooks — Manage webhooks

• help-scout-pp-cli webhooks — List webhook subscriptions.

workflows — Manage workflows

• help-scout-pp-cli workflows — List Help Scout workflows.

Finding the right command

When you know what you want to do but not which command does it, ask the CLI directly:

help-scout-pp-cli which "<capability in your own words>"

which resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code 0 means at least one match; exit code 2 means no confident match — fall back to --help or use a narrower query.

Auth Setup

Run help-scout-pp-cli auth setup for the URL and steps to obtain a token (add --launch to open the URL). Then store it:

help-scout-pp-cli auth set-token YOUR_TOKEN_HERE

Or set HELP_SCOUT_BEARER_AUTH as an environment variable.

Run help-scout-pp-cli doctor to verify setup.

Agent Mode

Add --agent to any command. Expands to: --json --compact --no-input --no-color --yes.

• Pipeable — JSON on stdout, errors on stderr

• Filterable — --select keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:

  help-scout-pp-cli conversations list --agent --select id,name,status

• Previewable — --dry-run shows the request without sending

• Offline-friendly — sync/search commands can use the local SQLite store when available

• Non-interactive — never prompts, every input is a flag

• Read-only — do not use this CLI for create, update, delete, publish, comment, upvote, invite, order, send, or other mutating requests