Supybook

A command that takes name as a required parameter and value as an optional parameter.

A command that takes one or more parameters.

A command that takes two optional options as parameters, eg. --foo value and/or --bar value.

A plugin name

List currently loaded plugins, excluding the ones set non-public.

List loaded plugins that are set to non-public.

List commands provided by the given plugin.

Load a plugin. Supybot looks for plugins in directories listed in config conf.supybot.directories.plugins. Use comma as a separator.

Unloads a plugin. The Owner plugin cannot be unloaded.

Get the current value of name, or set it to value if provided.

Ditto, but for channel configs.

Get the default value of name. This does not change the value. No, there is no command to reset an item to default value. You need to use config <name> [config default <name>] for that.

Export non-confidential parts of configuration to a file for debugging purposes.

Show help for a configuration item.

List configuration items in group. Subgroups are prefixed with @, channel-specific items with #.

Reloads configuration. Mostly useful if you’ve had to modify the files by hand.

Show configuration items matching word.

Save configuration changes to disk. This should be done automatically as well, if the flush configuration item is True (the default).

For bot owners: the people who have "physical" access to the bot and its files. This cannot be granted online; the conf/users.conf file must be edited by hand followed by reload. Owners are exempt from #channel,op capability checks and channel anticapabilities.

For bot administrators. Users with this capability can manage global bot properties, make the bot join new channels and so forth. However, they can’t do channel administration which is reserved for ops.

Channel ops can execute channel-related commands.

Allow user to run commands that can potentially crash the bot, or cause denial of service on the system it’s running on.

Connect to network. host must be provided if the network is new or has no servers defined.

Disconnects and connects network, or current if not specified. message, if given, is shown as the quit message, otherwise config plugins.Owner.quitMsg is used, or your nickname.

Disconnect network, or current if not specified. message as above.

List of networks & servers currently connected to.

List all networks.

Settings this is useful on Freenode and other networks who change the user mask after identifying to NickServ. In my experience this seems to be a tad buggy, so I don’t recommend enabling it unless really needed.

Tell the bot what name NickServ can be found under.

Can be used to set or remove NickServ password.

NOTE: Password removal did not work for me on Supybot 0.83.3

Identifies the bot to NickServ with the current nick. You don’t need to give this command after the bot has been set up; it will identify when connecting to the network automatically.

Tell the bot what name ChanServ can be found under.

Set the default for all channels. This will be used unless a channel-specific config overrides it.

Set to request op on the given channel.

Joins the channel using key if provided. Channels are automatically remembered and joined when the bot connects to the network next time.

Makes the bot leave channel, showing reason as part message if given. Note that all channel data is retained, but the bot does not join the channel anymore the next time it connects to the network.

Sets config item name on channel to value, overriding the global value.

Sets key on channel to key, or removes it if key is not given.

Sets limit on channel to limit, or removes it if limit is not given (or is zero).

Ops the given nicks (or you if none) on the channel.

Ditto, but deops.

Voices the given nicks (or you if none) on the channel.

Ditto, but devoices.

Bans and kicks the given nick from the channel. If seconds is specified and is not 0, the ban will expire after that time.

Set channel mode. This can be used to change any channel modes, making the commands below redundant aliases.

Set +m. This is not enforced by the bot, so any channel op can remove it.

Set -m.

Set +t. Not enforced, so any channel op can remove it.

Set -t.

Sends text to all users on the channel with op capability.

Make the bot part and join the channel. Mostly useful to test whether auto-ops from other bots/users work for the bot.

Add ban for given nick or hostmask on the channel. If nick is given, the full hostmask is banned. expires when gives, expires the ban after so many seconds.

List bans with their expire times.

Removes the ban on given hostmask.

Hostmask style for ban add: exact, nick, user, host. This means which parts of the nick’s current hostmask are used (rest are wildcarded). Default is host user (eg. *!user@host).

Ignores hostmask (or the full hostmask nick currently has) on channel. If expires is given, the ignore expires after that many seconds.

Show ignored hostmasks on channel. This does not show the expire times, though (argh!).

Remove hostmask from list of ignored hostmasks on channel.

Add a new topic item at the end.

Do a regular expression substitution on the topic item number. For example: topic change 2 s/foo/bar/.

Restore topic on channel to the default set with config plugins.Topic.default.

Adds a new topic item at the end like topic add, but if there isn’t enough space, first removes some items from the beginning. topic add complains if there isn’t enough space.

Return topic item number.

Add a new topic item in the beginning.

Return list of topic items.

Set channel mode +t, preventing non-opped users from changing the topic.

Undo the last undo.

Remove item number from the topic.

Reorder topic items in the given order. You must give as many numbers as there are items. For example, to move third item to first position, use topic reorder 3 1 2.

Replace topic item number with text.

Revert any changes made to the topic by users, and set it back to whatever the bot last set it to.

Change the topic separator to separator.

Replace either the whole topic or, if number is given, one item. In the latter case, this is the same as topic replace.

Reorder the topic items randomly.

Swap topic items at the given positions.

Show (the whole) topic for the channel.

Revert the last change a topic command made to the topic. Note that if users directly edited the topic, those changes will be lost. Can be used multiple times.

Set channel mode -t, allowing all users to change the topic.

Loads the AutoMode plugin, which works out-of-box. By default it’s enabled on all channels and voices/halfops/ops users with respective capabilities. You can enable auto-opping only on some channels by tweaking the config keys below.

List capabilities on channel.

Adds the given capability to channel.

Removes the given capability from channel.

Whether to allow users on channel by default to access non-maintenance related commands. Default is True.
Note that this concerns unregistered users as well. So if you want to disallow use of commands by unregistered users, set default user capabilities to allow them, and set this to False.

Make the bot silent and ignore all requests in the channel.

List channels the bot is silent on.

Break silence on a channel.

Add your current hostmask. Obviously this makes only sense after identify.

Add hostmask for another user. If not owner, password must be given.

Show hostmasks defined for the given user, or current user if none.

Remove the given hostmask from name.

List registered users, matching glob pattern if given. Note that the list of users is global across networks.

List capabilities of the user, or the calling user.

Add capability to user or a user that matches the hostmask.

Ditto, but remove the capability.

Add capability capability on channel to nick/user.

Remove capability capability on channel from nick/user.

Add or remove capability from list of capabilities given to new users.

List default capabilities given to new users.

Change nick to newnick.

Default nick.

Space-separated list of alternate nicks, %s refers to nick.

Sets the bot’s ident (nick!ident@host).

Sets the bot’s ircname/realname to ircname. If left empty, defaults to Supybot 0.83.3 for example.

List of characters the bot will recognize as addressing, besides the nick of the bot.

Ditto, but for a specific channel.

Assume everyone wants to talk to the bot, eg. treat all messages as if addressed to the bot. This does not imply reply.WhenNotCommand False which you should set as well.

Whether to reply when addressed with an invalid command.

Loads the plugin which works without further configuration.

Whether the plugin is actively checking for the primary nick. This setting makes no sense, as you might as well unload NickCapture if you think about setting this to false.

How many seconds to wait between nick availability polls. The default is 600 (10 min). The smaller you set this, the higher the chance of the bot recovering the nick when it becomes available. On the other hand, you will also generate more traffic so you might want to avoid that.

Find last URL (or all with --nolimit) matching given criteria. From matches nick, with(out) part of the URL, near rest of the line where the URL was, and proto matches the protocol (https, ftp, etc). In case of multiple URLs, the newest is listed first. Multiple criterias can be given.

NOTE: This command lists only the URLs, not nick or what message the URLs were part of. No date is shown either.

Find messages matching given criteria. From matches nick, in matches channel, on matches network, with(out) matches part of the message, regexp matches messages that are included by the regular expression. Also see config protocols.irc.maxHistoryLength.

Defines an alias name that executes alias. The alias should be in the standard "command argument [nestedcommand argument]" arguments to the alias; they’ll be filled with the first, second, etc. arguments. $1, $2, etc. can be used for required arguments. @1, @2, etc. can be used for optional arguments. $* simply means "all remaining arguments," and cannot be combined with optional arguments.

Removes the alias named name.

Sends action to channel. This is the same as a normal IRC client /me does something command.

Say text on channel.

Show dictionary entry for word, from dictionary if provided. If plugins.Dict.default is set, use the specified dictionary instead of all.

List dictionaries available on the used server.

Show a random dictionary from available dictionaries.

The dictd server to be used, default is dict.org.

Channel-specific default dictionary for dict command. * means to use all dictionaries. wn is a good default if english words are mostly looked up.

List nicks that have notes queued, or the notes queued for nick if given.

Queues text to be sent to first matching nick when seen. Nick can contain wildcards, eg. foo*.

How many messages can be queued per nick at maximum, default is 0 = no limit.

Whether to send notes in private or on the channel where the recipient is seen.

Add a command to be run seconds seconds later. For the seconds parameter you probably want to use seconds command available in the Time plugin, eg. scheduler add [seconds 1d 3h] echo $who: give feedback on supybook.

Lists scheduled events, with their id for removal. Unfortunately it does not show much time is left until each event.

Removes event id. id can be a numerical value as given by scheduler add and scheduler list, or a name that was given via scheduler repeat.

Like scheduler add, but adds a repeating command, and allows giving a name for it. The first trigger happens immediately, and then after every seconds.

Lists any activity given nick or user was doing on the channel. If no nick or user is given, returns the last activity on the channel, regardless of who it was from.

Last line said on the channel.

Last time a nick was seen on a channel and what it said.

Show unix epoch timestamp for time string. Supybot internally uses python-dateutil for the parsing, so a wide variety of formats is supported. See section 8.3.4 for the examples.

Show formatted date for unix epoch timestamp seconds, for example Thu Jan 1 00:00:00 1970.

Shows how many years/weeks/days/hours/minutes/seconds seconds equals to. Counterpart of time seconds below.

Convert given years/weeks/days/hours/minutes into seconds. Very useful with the Scheduler plugin. I have hard time remembering that you can not have space after each number, though.

Formats the given unix epoch timestamp in format, using python’s time.strftime.

How many seconds are until time string. Same format as for time at. The given time can also be in the past, making the result negative.

Show the doctype line of url, if any.

Show the contents of url. Amount of data shown is determined by the configuration variable plugins.Web.fetch.maximum.

Show web server headers for the url.

Ask netcraft what OS and web server it thinks the server is running.

Show size of url, based on the Content-Length header sent by the web server.

Show title for url. This can be done automatically for all URLs pasted on a channel; see the configuration variable plugins.Web.titleSnarfer.

Return text quoted into a URL. Eg. urlquote foo bar → foo%20bar.

Likewise, but reverse.

Heads or tails?

Roll dices dices, each having sides sides. Lists result for each dice separately. The sum will be between dices and dices x sides.

Answers a question. But don’t expect the bot to pass

Check how long your monologue on the channel is, in case you are lose count. This is probably my favourite useless command.

Russian roulette. If spin is given, spins the chambers. This isn’t really necessary since it will be done automatically at the end of the round. Provides a different experience if the bot is opped.

Add text as a quote for channel.

Change quote id on channel using regexp. For example, s/foo/bar/g changes all instances of foo to bar.

Show quote # id for channel.

Show random quote from channel.

Remove quote # id from channel.

Find quotes from channel matching regexp if provided, added by nick by if provided, and matching glob if provided. glob may contain wildcards (eg. foo*bar), while regexp is a regular expression (eg. /la.*laa/). Note that you can really provide both regexp and the glob - both must match in that case.

Show how many quotes there are.

Show quote # id .

Save last line from nick as a quote.

List quotes for nick, newest first. This does not display full quotes, but part of each, along with the id.

Show last quote of nick.

Random quote from any nick, or nick if provided.

Show quotes containing text. Unfortunately, this does not list the nick or allow searching only given nick’s quotes. Id and quote content will be shown.

Whether to reply in private to commands given on channel.

-

Whether to be extra helpful when a user fails syntax of a command.

Assume everyone wants to talk to the bot, eg. treat all messages as if addressed to the bot. This does not imply reply.WhenNotCommand False which you should set as well.

Whether to reply when addressed with an invalid command.

Whether to prefix the reply with the nick of the user who gave the command.

Whether to use notices instead of regular messages.

How many messages to send initially before prompting for more. Default is 1.

How long messages can be. Default is 0, which uses rocket science to determine the maximum number of characters that can be fit into a message without it collapsing into a black hole.

Maximum number of messages to queue, default is 50.

Whether to send errors in private instead of replying on channel.

If True, don’t tell users why they can not run a command because of missing capabilities.

Whether to send errors as notices instead of regular messages.

Whether to show an exception or a generic error when something breaks. Mostly useful for developers.

Format string for timestamps (%I:%M %p, %B %d, %Y, eg. 08:41 PM, September 11, 2008).

List of characters the bot will recognize as addressing (when a command is prefixed with one of them), besides the nick of the bot.

List of extra nicks to consider as addressing the bot, despite the current nick.

Like the chars key, except a space-separated list of strings to accept as command prefix. This allows multicharacter command prefixes.

Whether to consider messages that end in the bot’s nick to be addressed to the bot.

Maximum length of a reply message from the bot. This does not mean the length of a single message (prompting for more), but the whole message.

Whether to send replies consisting of multiple messages in a single message.

Whether to use notices instead of private messages.

For backups of config files.

Configuration files: {channels,ignores,userdata,users}.conf

Plugin databases.

Channel-specific plugin databases.

Temporary plugin data files (eg. database journals).

Logs.

ChannelLogger logs. The structure depends on the config variables.

The main logfile.

Local plugin directory. This is by default listed in config directories.plugins.

The main configuration file of the bot.

Temporary files.