PHPackages                             phergie/phergie-irc-plugin-react-commandhelp - 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. [Utility &amp; Helpers](/categories/utility)
4. /
5. phergie/phergie-irc-plugin-react-commandhelp

AbandonedArchivedLibrary[Utility &amp; Helpers](/categories/utility)

phergie/phergie-irc-plugin-react-commandhelp
============================================

Phergie plugin for providing usage information for available bot commands to users

2.1.1(10y ago)25.2k4BSD-2-ClausePHP

Since Dec 24Pushed 6y ago4 watchersCompare

[ Source](https://github.com/phergie/phergie-irc-plugin-react-commandhelp)[ Packagist](https://packagist.org/packages/phergie/phergie-irc-plugin-react-commandhelp)[ RSS](/packages/phergie-phergie-irc-plugin-react-commandhelp/feed)WikiDiscussions master Synced today

READMEChangelog (3)Dependencies (4)Versions (6)Used By (0)

This project is abandoned
=========================

[](#this-project-is-abandoned)

This repo is being kept for posterity and will be archived in a readonly state. If you're interested it can be forked under a new Composer namespace/GitHub organization.

phergie/phergie-irc-plugin-react-commandhelp
============================================

[](#phergiephergie-irc-plugin-react-commandhelp)

[Phergie](http://github.com/phergie/phergie-irc-bot-react/) plugin for providing usage information for available bot commands to users.

This plugin is intended to complement the [Command plugin](https://github.com/phergie/phergie-irc-plugin-react-command).

[![Build Status](https://camo.githubusercontent.com/df9ac1c5ea4df7d22084e7bb4b013d501eb55b43b5054278d18d26d41b4b6b3b/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f706865726769652f706865726769652d6972632d706c7567696e2d72656163742d636f6d6d616e6468656c702e706e673f6272616e63683d6d6173746572)](http://travis-ci.org/phergie/phergie-irc-plugin-react-commandhelp)

Install
-------

[](#install)

The recommended method of installation is [through composer](http://getcomposer.org).

```
composer require phergie/phergie-irc-plugin-react-commandhelp

```

See Phergie documentation for more information on [installing and enabling plugins](https://github.com/phergie/phergie-irc-bot-react/wiki/Usage#plugins).

Configuration
-------------

[](#configuration)

```
    // All configuration is optional
    new \Phergie\Irc\Plugin\React\CommandHelp\Plugin([

        // List of plugins that subscribe to command events
        // Used to return a list of available commands to users
        // All elements must implement \Phergie\Irc\Bot\React\PluginInterface
        'plugins' => [
            new Phergie\Irc\Plugin\React\TableFlip\Plugin()
        ],

        // Text to precede the list of available commands when providing it to
        // users
        'listText' => 'Available commands: ',

    ]),
```

Usage
-----

[](#usage)

This plugin provides a "help" command that can be invoked with or without parameters.

If it is invoked without parameters, it will respond with a list of all available commands, which is obtained from the value of the `'plugins'`configuration setting based on the command events to which those plugins subscribe.

If it is invoked with parameters, it will assume the first parameter to be a command name and emit an event for the plugin supporting that command to respond to.

For example, if the first parameter value is `'foo'`, the plugin will emit a `'command.foo.help'` event that the plugin supporting the "foo" command can subscribe to. This event's parameters will be an object implementing [`CommandEventInterface`](https://github.com/phergie/phergie-irc-plugin-react-command/blob/master/src/CommandEventInterface.php)(the event originally received by the CommandHelp plugin) and an object implementing [`EventQueueInterface`](https://github.com/phergie/phergie-irc-bot-react/blob/master/src/EventQueueInterface.php)(which the receiving plugin can use to respond with information about its "foo" command to the user who invoked the "help" command).

Tests
-----

[](#tests)

To run the unit test suite:

```
curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit

```

License
-------

[](#license)

Released under the BSD License. See `LICENSE`.

###  Health Score

35

—

LowBetter than 80% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity23

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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

Every ~162 days

Total

4

Last Release

3666d ago

Major Versions

1.0.0 → 2.0.02015-12-21

### Community

Maintainers

![](https://www.gravatar.com/avatar/80dec604abed1b21daafc54c430468444a2ad163ad5f8229348b8d241b797778?d=identicon)[elazar](/maintainers/elazar)

---

Top Contributors

[![svpernova09](https://avatars.githubusercontent.com/u/967362?v=4)](https://github.com/svpernova09 "svpernova09 (15 commits)")[![elazar](https://avatars.githubusercontent.com/u/15487?v=4)](https://github.com/elazar "elazar (13 commits)")[![cebe](https://avatars.githubusercontent.com/u/189796?v=4)](https://github.com/cebe "cebe (2 commits)")[![matthewtrask](https://avatars.githubusercontent.com/u/4731244?v=4)](https://github.com/matthewtrask "matthewtrask (2 commits)")[![Renegade334](https://avatars.githubusercontent.com/u/9092381?v=4)](https://github.com/Renegade334 "Renegade334 (1 commits)")[![sitedyno](https://avatars.githubusercontent.com/u/216721?v=4)](https://github.com/sitedyno "sitedyno (1 commits)")

---

Tags

pluginbotreactirc

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/phergie-phergie-irc-plugin-react-commandhelp/health.svg)

```
[![Health](https://phpackages.com/badges/phergie-phergie-irc-plugin-react-commandhelp/health.svg)](https://phpackages.com/packages/phergie-phergie-irc-plugin-react-commandhelp)
```

PHPackages © 2026

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