PHPackages                             helpscout/helpscout-cli-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI &amp; Console](/categories/cli)
4. /
5. helpscout/helpscout-cli-php

ActiveLibrary[CLI &amp; Console](/categories/cli)

helpscout/helpscout-cli-php
===========================

Help Scout Command Line Client

0.0.1(10y ago)41MITPHP

Since May 27Pushed 3y ago49 watchersCompare

[ Source](https://github.com/helpscout/helpscout-cli-php)[ Packagist](https://packagist.org/packages/helpscout/helpscout-cli-php)[ Docs](https://github.com/helpscout/helpscout-cli-php)[ RSS](/packages/helpscout-helpscout-cli-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (11)Versions (2)Used By (0)

⚠️ Help Scout's v1 API has been deprecated, making this project obsolete. See [Mailbox API v2 documentation](https://developer.helpscout.com/mailbox-api/) ⚠️

Help Scout Command Line Tools [![Build Status](https://camo.githubusercontent.com/ebe88bf6e0832eda3c772bb8ea6ba6b3bf7ddf99508c195ef883594aadf0e8db/68747470733a2f2f7472617669732d63692e6f72672f68656c7073636f75742f68656c7073636f75742d636c692d7068702e737667)](https://travis-ci.org/helpscout/helpscout-cli-php) [![Code Climate](https://camo.githubusercontent.com/7ba04928a0b45da1671e94295fde699d94734a007644aea28852318db1efff98/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f68656c7073636f75742f68656c7073636f75742d636c692d7068702f6261646765732f6770612e737667)](https://codeclimate.com/github/helpscout/helpscout-cli-php)
========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

[](#help-scout-command-line-tools--)

> Command line interface for Help Scout :: API example application

A simple command line client application that can be used with Help Scout. This is built using the [Symfony Console](http://symfony.com/doc/current/components/console.html) and the [PHP API Client](https://github.com/helpscout/helpscout-api-php).

This is an example project used to demonstrate the Help Scout API. It's much more common to use the API to build:

- Custom Integrations with your other tools
- A synchronization tool
- An intranet dashboard interface
- Or a million other things!

But, we love programmers, and there's something magic about having Help Scout on the command line too!

Quick Start
-----------

[](#quick-start)

Run the `bin/helpscout` file from the command line. It will prompt you for your API key. It will store an API token in a `~/.helpscout.yml` file.

Help
----

[](#help)

```
Help Scout Command Line Client version 0.0.1 by Help Scout

Usage:
  command [options] [arguments]

Options:
  -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

```

Examples
--------

[](#examples)

Dependencies
------------

[](#dependencies)

This app requires PHP 5.5 and Composer.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 88.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

4009d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ebe68856d5769ac3eda6c6ebef50a91ec2f3983df668ff7afedf8bfc561da250?d=identicon)[dswindle](/maintainers/dswindle)

![](https://www.gravatar.com/avatar/06719ba09ce20c0774f7b29346b41890f497cb06252f3b8b701fd0df32abd082?d=identicon)[craig-davis](/maintainers/craig-davis)

![](https://www.gravatar.com/avatar/2a560935372705d52a621836e7bee49a6d6576c646bc87feb4c7832baf9e8fc0?d=identicon)[helpscout](/maintainers/helpscout)

---

Top Contributors

[![craig-davis](https://avatars.githubusercontent.com/u/9907304?v=4)](https://github.com/craig-davis "craig-davis (15 commits)")[![bkuhl](https://avatars.githubusercontent.com/u/524933?v=4)](https://github.com/bkuhl "bkuhl (2 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/helpscout-helpscout-cli-php/health.svg)

```
[![Health](https://phpackages.com/badges/helpscout-helpscout-cli-php/health.svg)](https://phpackages.com/packages/helpscout-helpscout-cli-php)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[simplesamlphp/simplesamlphp

A PHP implementation of a SAML 2.0 service provider and identity provider.

1.1k12.4M193](/packages/simplesamlphp-simplesamlphp)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[crunzphp/crunz

Schedule your tasks right from the code.

2292.0M6](/packages/crunzphp-crunz)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
