Maiden-Help

About

This is an agent that provides a generic help and introspection facility, with the hopes that it will make it easier to discover the available commands and features that the system offers.

How To

The help command should do pretty much everything. The following terms are handled specially:

uptime
about

Otherwise the term is first attempted to be interpreted as a command name, otherwise as the name of a consumer, and finally as a command search term.

::help about
::help list
::help about command

Copyright

maiden-help is licensed under the Artistic license. © Nicolas Hafner <shinmera@tymoon.eu> . This library can be obtained on https://github.com/Shinmera/maiden.

Package Index

MAIDEN-HELP (ORG.SHIRAKUMO.MAIDEN.AGENTS.HELP)

class
ABOUT
```
 
```
class
ABOUT-COMMAND
```
 
```
class
ABOUT-CONSUMER
```
 
```
class
ABOUT-SELF
```
 
```
class
ABOUT-TERM
```
 
```
class
ABOUT-UPTIME
```
 
```

class

`HELP`

This agent provides generic help commands that should provide information for the user and help in discovering the system interactively.

class
LIST-CONSUMERS
```
 
```

command (

`help`

&REST ABOUT)

This is the generic interface for the help system. Depending on what it finds for the term, it dispatches to other help commands.

command (

`about command`

&REST COMMAND)

This displays available information about a command that the bot supports.

command (

`about consumer`

CONSUMER)

This displays documentation information about a consumer (system) that's running on the bot.

command

`about self`

This displays a blurb that describes some information about the bot and its current status.

command (

`search`

TERM)

This searches for a command that approximately matches the given term. It displays a list of up to ten matches, in decreasing order of similarity.

command

`uptime`

This displays information about the running time of the bot.

command

`list consumers`

List all the consumers (systems) that are running on the bot.

maiden-help

About

How To

Copyright

Package Index

MAIDEN-HELP (ORG.SHIRAKUMO.MAIDEN.AGENTS.HELP)

`ABOUT`

`ABOUT-COMMAND`

`ABOUT-CONSUMER`

`ABOUT-SELF`

`ABOUT-TERM`

`ABOUT-UPTIME`

`HELP`

`LIST-CONSUMERS`

`help`

`about command`

`about consumer`

`about self`

`search`

`uptime`

`list consumers`