codekitchen/tkellem

View on GitHub
resources/bot_command_descriptions.yml

Summary

Maintainability
Test Coverage
--- 
LISTEN:
  banner: "Usage: LISTEN [--remove] <uri>"
  help: |+

    Manage the address/port combinations for tkellem to accept client
    connections on.

    Protocol is either `irc`, or `ircs` for an SSL listener.

    Examples:
        LISTEN ircs://0.0.0.0:10001
        LISTEN --remove ircs://0.0.0.0:10001

USER:
  banner: "Usage: USER [--remove] <username> [--role=<admin|user>]"
  help: |+

    Manage users.

    Example:
        USER joe --role=admin
        USER joe --role=user
        USER --remove joe

PASSWORD:
  banner: "Usage: PASSWORD <new-password>"
  help: |+

    Change password.

    Example:
        PASSWORD hunter2

NETWORK:
  banner: "Usage: NETWORK [--remove] [--public] [--name=<network-name>] <uri>"
  help: |+

    Manage networks. Will add a new network, or a new connection host to an existing network. Public networks can only be created by admins, and can be joined by anybody.

    To connect to a network, change the server username in your irc client to reflect what network you want to connect to, in the form of username@network. For instance, to connect to a network called "freenode" as the user "joe", you would set your username to joe@freenode

    Examples:
        NETWORK ircs://irc.freenode.org:7000 # operate on the current network
        NETWORK --name=freenode ircs://irc.freenode.org:7000
        NETWORK --remove --name=freenode ircs://irc.freenode.org:7000
        NETWORK --remove --name=freenode

ATCONNECT:
  banner: "Usage: ATCONNECT [--remove] <command>"
  help: |+

    Add or remove an IRC command to run at connect.

    Examples:
        ATCONNECT /join #tkellem
        ATCONNECT --remove /join #tkellem

SETTING:
  banner: "SETTING [<name>] [<new_value>]"
  help: |+

    View and modify global settings.

    Examples:
        SETTING
        SETTING user_registration open

BACKLOG:
  banner: "BACKLOG [<room or user>] <hours>"
  help: |+

    View backlog for a given room (or all rooms).

    Examples:
      view 3 hours of backlog for all rooms:
        BACKLOG 3
      view 2 hours of backlog for the #friends room:
        BACKLOG #friends 2