A powerful command-line interface for managing HelpScout Inbox and Docs APIs, enabling full CRUD operations for conversations, customers, and knowledge base articles.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install help-scout
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install help-scout using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is HelpScout CLI (hs)?
The hs CLI provides a unified interface for interacting with HelpScout services directly from your terminal. It supports two primary namespaces: hs inbox for Mailbox API operations like managing conversations and customers, and hs docs for Docs API tasks such as site and article management. By integrating this tool into your Openclaw Skills workflow, you can automate support tasks, redact PII for security, and manage multiple mailboxes with ease.
Built for efficiency, the tool supports OAuth2 and API key authentication, credential storage in the OS keyring, and flexible output formats including JSON and CSV. It is an essential utility for developers and support engineers who want to streamline their HelpScout operations without leaving the command line.
HelpScout CLI (hs) Use Cases
- Bulk updating conversation statuses or tags across multiple mailboxes.
- Automating the creation and synchronization of Docs articles and categories.
- Generating daily briefings and productivity reports for support agents.
- Securely managing customer data with deterministic PII redaction.
- Integrating HelpScout workflows into CI/CD pipelines or automated scripts via Openclaw Skills.
How HelpScout CLI (hs) Works
- Authenticate using hs inbox auth login for Mailbox API (OAuth2) or hs docs auth login for the Docs API.
- Configure default settings such as mailbox IDs and output formats in the config.yaml file.
- Execute commands to query or modify resources, such as hs inbox conv list or hs docs articles create.
- Apply global flags like --format json or --no-paginate to customize data retrieval and processing.
- Utilize the permissions system to restrict agent access to specific resources or operations for enhanced security.
HelpScout CLI (hs) Setup
To get started with this tool as part of your Openclaw Skills library, install it via Homebrew:
brew tap operator-kit/tap
brew install hs
After installation, run the login commands to link your HelpScout account:
hs inbox auth login
hs docs auth login
HelpScout CLI (hs) Data Schema & Taxonomy
The hs CLI organizes data into two main API namespaces with distinct structures. Data can be exported in several formats to suit your needs within Openclaw Skills.
| Namespace | Key Resources | Description |
|---|---|---|
| Inbox | Conversations, Customers, Mailboxes, Users, Teams | Handles support tickets, customer profiles, and team management. |
| Docs | Sites, Collections, Categories, Articles, Redirects | Manages the knowledge base, documentation hierarchy, and assets. |
Configuration is stored at ~/.config/hs/config.yaml (Linux/macOS) or %AppData%\hs\config.yaml (Windows).
HelpScout CLI (hs) Advanced Features
- PII Redaction: Deterministic masking of customer and user identities for data privacy.
- Permissions Allowlist: Granular control over command execution using resource:operation pairs.
- Multi-format Output: Native support for table, JSON, full JSON, and CSV outputs for easy piping.
- Automated Pagination: Use the --no-paginate flag to automatically fetch all records in a single command.
- Daily Briefings: Generate agent-specific summaries with the hs inbox tools briefing command.
SKILL.md
Loading
Related Openclaw Skills
ghapp
A CLI utility that grants AI agents and automations their own GitHub App identity for seamless, bot-attributed git and gh operations.
Kosmi Video DJ
An automated media controller that uses browser automation to manage video playback and DJ duties within Kosmi watch party rooms.
Scannable Reports
A specialized skill for formatting AI agent outputs into mobile-optimized, Unicode-based visual reports for chat platforms.
Board of Mentors: Domain Expert AI Advisors
A collection of 17 specialized AI mentor personas designed to provide strategic wisdom and domain-specific guidance for founders and operators.
ActivityClaw Plugin
A real-time activity monitoring plugin for tracking file operations, command executions, and web searches performed by your AI agent.
ContextClaw
ContextClaw is a comprehensive session management and cleanup utility designed to optimize storage and analyze token consumption for AI agents.
Featured*
