I’ve started on a new toy project - a command line client for Help Scout. This project serves two purposes:

  • Provide a tool for me to use during the work day
  • Be an example of using the excellent Help Scout API.

Current Commands

Help Scout Command Line Client version 0.0.1 by Help Scout

  command [options] [arguments]

  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  customer   Show customer details
  help       Displays help for a command
  list       Lists commands
  mailbox    Show mailbox details
  mailboxes  List all mailboxes
  setup      Configure this Help Scout client
  version    Show version information
  zen        Display a Zen koan, used as an API heartbeat

Example Output

$ helpscout mailboxes

                              Help Scout Mailboxes
 ID         Name                           Email
 [25590]    Research                       [email protected]
 [85]       Help Scout                     [email protected]
 [2641]     Developer Support              [email protected]
 [20512]    Customer Success               [email protected]