EyeInTheSky - Commands
The latest help for all commands can be found using the =help command.
Help
Requires: Standard
=help
=help <Command>
Returns all available help for the specified command.
=help <Command> <Subcommand>
Returns the help for the specified subcommand.
Location: Stwalkerster.Bot.CommandLib.Commands
Die
Requires: Owner
=die
Shuts down the bot.
Location: Stwalkerster.Bot.CommandLib.Commands.BotManagement
Command Access
Requires: Standard
=commandaccess <command>
Retrieves the flag required to use the specified command.
Location: Stwalkerster.Bot.CommandLib.Commands.AccessControl
My Flags
Requires: Standard
=myflags =myaccess =whoami
Retrieves the flags available to the current user.
Location: Stwalkerster.Bot.CommandLib.Commands.AccessControl
Stalk
Requires: Standard (subscribe, unsubscribe, list, report); Configuration (everything else)
=stalk list
Lists all configured active stalks in the current channel
=stalk report
Sends an email listing the configured stalks in the current channel
=stalk subscribe <Flag>
Subscribes to notifications for this stalk. Must have a confirmed email address.
=stalk unsubscribe <Flag>
Unsubscribes from notifications for this stalk.
=stalk add <Flag>
Adds a new unconfigured stalk
=stalk del <Flag>
Deletes a stalk
=stalk enabled <Flag> <true|false> =stalk enable <Flag> =stalk disable <Flag>
Marks a stalk as enabled or disabled
=stalk description <Flag> <Description...>
Sets the description of the specified stalk
=stalk expiry <Flag> <Description...>
Sets the description of the specified stalk
=stalk set <Flag> <user|page|summary|xml> <Match...>
Sets the stalk configuration of the specified stalk to specified user, page, or edit summary regex. Alternatively, use a pre-cached XML tree (advanced).
=stalk and <Flag> <user|page|summary|xml> <Match...>
Sets the stalk configuration of the specified stalk to the logical AND of the current configuration, and a specified user, page, or edit summary regex; or XML tree (advanced).
=stalk or <Flag> <user|page|summary|xml> <Match...>
Sets the stalk configuration of the specified stalk to the logical OR of the current configuration, and a specified user, page, or edit summary regex; or XML tree (advanced).
=stalk clone <SourceChannel> <SourceFlag> <DestFlag>
Clones a stalk from another channel into the current channel.
=stalk refresh <Flag>
Reloads any stalk data from external providers if it has been updated at the remote end.
=stalk watchchannel <Flag> <Channel>
Changes the monitoring channel the bot uses to watch for hits on this stalk.
An XML search tree is an XML root element from the list: and, or, not, xor, true, false, user, page, summary, flag, incategory, log, usergroup, x-of, external.
xor MUST have two child nodes, not MUST have one child node, and, or, and x-of can have any number of child nodes, and the rest MUST have zero child nodes.
user, page, flag, log and summary MUST have an attribute called value containing a regular expression to match. They may have a caseinsensitive attribute determining the case sensitivity of the regex match - by default the regex is case sensitive.
incategory, and usergroup MUST have an attribute called value containing an exact string to match.
external must have a provider attribute (currently only phabricator is supported), and a location attribute (currently this is the Paste ID of the paste where the actual tree is stored).
For example:
<and> <or> <page value="Wikipedia:New contributors' help page"/> <page value="Wikipedia:Help Desk"/> </or> <not> <user value="Stwalkerster"/> </not> <summary value="/\* New Section \*/"/> </and>
Location: EyeInTheSky.Commands
XML
Requires: Standard
=xml <xml>
Precaches XML for use in a =stalk <and|or|set> <flag> xml command.
Location: EyeInTheSky.Commands
Channel
Requires: Standard (subscribe, unsubscribe, list); LocalAdmin (part); GlobalAdmin (join)
=channel subscribe
Subscribes to all email notifications in this channel. Must have a confirmed email address.
=channel unsubscribe
Unsubscribes from all email notifications in this channel.
=channel list
Lists all the channels in which you have active subscriptions
=channel join <channel>
Requests the bot join a new channel.
=channel part <channel>
Requests the bot leave the specified channel.
Location: EyeInTheSky.Commands
Account
Requires: Standard (register, delete, email); GlobalAdmin (forcedelete, forcenomail)
=account register
Registers your NickServ account with the bot.
=account delete
Deletes your account with the bot
=account email <email>
Associates an email address with your account
=account email none
Removes the email address associated with your account
=account forcedelete <account>
Forcibly deletes an account
=account forcenomail <account>
Forcibly removes an email address from an account
Location: EyeInTheSky.Commands
Flags
Requires: LocalAdmin or GlobalAdmin (dependent on scope)
=flags local <account> <changes>
Modifies the flags for the account in the local channel
=flags global <account> <changes>
Modifies the flags for the account across all channels
Available flags are:
Flag | Name | Available locally | Available globally | Notes |
---|---|---|---|---|
S | Standard | No | No | Not grantable, automatically applies to all users |
a | LocalAdmin | Yes | Yes | Automatically granted locally to chanops, makes little sense to grant globally, but possible |
A | GlobalAdmin | No | Yes | |
C | Configuration | Yes | Yes | |
O | Owner | No | Yes* | Only grantable globally by someone already with this flag |
Changes should be specified similarly to an IRC mode string - eg +AC-a. It is possible to revoke all flags with -*
Location: EyeInTheSky.Commands
Version
Requires: Standard
=version
Shows the current bot version.
Location: EyeInTheSky.Commands
- Last Author
- stwalkerster
- Last Edited
- Apr 10 2019, 10:54 PM