Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
This wiki page contains a list of commands and their explanation.
Commands for everyone
These commands can be executed by everyone.
!!/live— Replies a random message taken from a list so you can see that SmokeDetector is still running.
!!/status— Shows the UTC date when SmokeDetector started running.
!!/ms-status— Shows the status of MetaSmoke.
!!/ver— Shows the running Git revision.
!!/commands— Shows a small help message about SmokeDetector.
!!/apiquota— Shows the remaining API quota of SmokeDetector.
!!/queuestatus— Shows the queue status of BodyFetcher.
!!/blame— Chooses randomly from a list of people who have talked recently in the room.
!!/brownie— better versions of
!!/alive, aka 'fun' commands.
!!/location— Replies with the current location, as set in the
!!/test site=<site_domain> <string>— Runs
<string>against the filter as if it appeared in a question title, body, or username. To test specifically, use
!!/test-qfor question body,
!!/test-tfor title, or
!!/test-ufor username. Note that the site is optional. If site is present, the command will use filters for that site.
!!/iswlu— Checks if a user is blacklisted/whitelisted. Two formats are accepted:
!!/whoami— Replies with the bot's user id for that site
!!/whois admin— Replies with a list of admins (and who's currently in the room).
!!/whois code_admin— Replies with a list of code admins (and who's currently in the room).
!!/amiprivileged— Lets you know if you are in the list of privileged users
!!/amicodeprivileged— Lets you know whether or not you have code privileges (i.e. you can blacklist without approval)
!!/notify <chatroom_ID_number> <site_domain>— Tells SmokeDetector to ping you, in the given chatroom, when a post is reported on the given site.
!!/notify- 89 parenting.stackexchange.com
Note: Please use the squelch suffix (
-) and avoid spamming the chat room with too many requests. See this chat message and the surrounding context.
!!/unnotify <chatroom_ID_number> <site_domain>— Cancels the previously set notification. Also, accepts the silent mode suffix (
!!/unnotify-all- Removes all notifications.
!!/willbenotified <chatroom_ID_number> <site_domain>— Reports whether you will be pinged, in the given room, about spam on the given site.
!!/allnotificationsites <chatroom_ID_number>— Shows all sites that you will be pinged for in the given room.
Commands as reply for everyone
why— Shows the reason that SmokeDetector caught a post.
whydata is only kept for the last 50 reports. If you need to see older data, it can be found in the post record on Metasmoke.
autoflagged— Returns if the post was autoflagged or not, and if so, what users were used.
These commands require privileges.
!!/report <post URL 1> [<post URL 2> [...]] ["custom reason"]— Makes SmokeDetector scan and report a specific post/multiple specific posts in Charcoal HQ and other applicable rooms. Recommended over
!!/scanif you're sure the post is spam. The originator of each post will be added to the blacklist if the post wouldn't have been caught otherwise. Maximum 5 posts at a time. An optional custom reason may be supplied so others are clearer why you're reporting it. Additionally, the post will be added to the database on Metasmoke, just like all other reported posts.
!!/scan <post URL 1> [<post URL 2> [...]] ["custom reason"]— Forces SmokeDetector to scan a post. This is useful when you're not sure if a post is spam and don't want to report it. Smokey will go through all the usual processes of scanning a post and report it if it's spam, and will tell you that it's not spam otherwise. If you're sure it's spam but it isn't being caught, use
!!/reportinstead. A custom scan reason may be supplied.
!!/allspam <user URL>— To be used if a spammer has many posts so you don't have to use
!!/report. This command posts a message about the user in all applicable rooms. Note that this command does NOT auto-TPU anything, for various reasons. Both individual site and network-wide user profiles are supported. It has an alias,
!!/reportuser <user URL>.
!!/blacklist— This command is deprecated. Use one of the three specialized blacklist commands instead, which are shown below. If run, this command will print a help.
!!/blacklist-website <regex>— Adds a regular expression pattern to the website blacklist. Make sure regex special characters are escaped (in particular
.characters should be escaped as
\.). If you are a code admin on metasmoke, your change will apply immediately once CI passes; otherwise, a pull request will be created for your changes so that it can be reviewed.
!!/blacklist-keyword <regex>— Adds a regular expression pattern to the list of bad keywords. Just like
!!/blacklist-website, if you are a code admin on metasmoke your change will apply immediately once CI passes; otherwise, a pull request will be created for your changes so that it can be reviewed.
!!/blacklist-username <regex>— Adds a regular expression pattern to the username blacklist. Just like
!!/blacklist-keyword, if you are a code admin on metasmoke your change will apply immediately once CI passes; otherwise, a pull request will be created for your changes so that it can be reviewed.
!!/watch <regex>- Adds a regular expression pattern to a "watch list" which is similar to the list of bad keywords (see
!!/blacklist-keywordabove) but with less strict criteria for what you can list. The intent is that you can set up SmokeDetector to watch for something and be alerted when it actually happens. Typical phrases to watch include domain names and phrases which have not occurred before but not enough to actually blacklist (yet). The long version of this command is
!!/unwatch <regex>- Removes a previously-added regular expression from the watchlist. Only code admins can use this command; it will only accept an exact match to a regular expression in the watchlist.
!!/unblacklist <regex>- Similar to
unwatch, removes a previously-added regular expression from the blacklists. Only code admins can use this command; it will only accept an exact match to a regular expression in the blacklists.
!!/feedback <post_URL> <feedback_type>- Takes a valid SE post URL as input, and manually sends the given feedback to metasmoke. Note that this won't blacklist/whitelist users automatically.
!!/addwlu <user_ID> <site_name>— Adds a user to the whitelist (this means that if the username for that user matches one of the regexes, this will be ignored).
!!/rmwlu <user_ID> <site_name>— Removes a user from the whitelist.
!!/addblu(same syntax as
!!/addwlu) — Adds a user to the blacklist (this means that any post of this user will be reported).
!!/rmblu(same syntax as
!!/rmwlu) — Removes a user from the blacklist.
!!/reboot— Reboots SmokeDetector.
!!/stappit— Stops all SmokeDetector instances.
!!/stappit <string>— Stops all SmokeDetector instances where
stringis included in the location (e.g.
!!/stappit undowould stop
Undo/DO, but not
!!/standby <string>- Places that instance into standby mode.
!!/standby-except <string>- Places all other instances into standby mode, use if multiple instances are running.
!!/pull— Pulls new revisions from GitHub.
!!/master— When SmokeDetector enters reverted mode, use this command to go back to the
!!/errorlogs <N>— Shows the last N lines of the error logs. (You can also use
!!/block <N>— Blocks SmokeDetector globally for N seconds; no alerts will be posted. Example:
!!/block 600blocks globally for 10 minutes.
!!/block <N> <room_id>— Blocks SmokeDetector in the specific room for N seconds; no alerts will be posted there. Example:
!!/block 3600 89blocks alerts in the Tavern for one hour.
!!/unblock— Unblock SmokeDetector manually, resetting global block only.
!!/unblock <room_id>— Unblock SmokeDetector manually in the specific room.
!!/invite <room_id> <roles separated by commas...>- Temporarily invites SmokeDetector to the given room on the current site. Roles are the same as in
!!/stopflagging- An emergency measure to immediately disable all autoflagging. Once disabled, autoflagging can only be re-enabled by an Admin.
Privileged commands as reply
These commands require privileges and have to be posted as a reply to a message of SmokeDetector.
offensivefor posts that should be flagged as such (equivalent to
tpu-; see below)
vandalismfor posts that have been vandalised and the vandalism edit should be rolled back (equivalent to
notspamif the post should not be flagged (equivalent to
true— Marks a reported post as true positive.
trueu— Marks a reported post as true positive and adds the poster to the blacklist.
false— Marks a reported post as false positive. Additionally removes the user from the blacklist, if that was the reason that the post was reported.
falseu— Marks a reported post as false positive and adds the poster to the whitelist.
naa— If the reported post is an answer, this command records it as NAA (Not an answer) in metasmoke.
ignore— Makes SmokeDetector ignore a reported post.
gone— Deletes a message of SmokeDetector. This has been disabled in CHQ for reports due to the reasons listed below. But if you really need to delete a report, use
postgone— Edits out the post link of a SmokeDetector report. If in CHQ, this should be used sparingly.
Silent mode and aliases
If you don't want SmokeDetector to reply when executing a command add a
- sign at the end, for example,
fp-. This is a good practice to cut down on chatroom clutter. Note that SmokeDetector will always report any errors, even if the
- is present. The hyphen can be placed after the command itself or after its parameter. The following commands support silent mode: replying to spam reports, managing black- and white-list, and managing chat notifications.
Also, some frequently used commands have one-letter aliases or convenient words that can be used instead:
A note on message deletion
Messages by SmokeDetector can be deleted within 2 minutes after they were posted by using the
gone commands. After 2 minutes are up, SmokeDetector cannot delete its own messages in response to those commands, so any deletion after that window must be done by a moderator.
Messages will also be deleted in Tavern on the Meta and SO Close Vote Reviewers, or Raiders of the Lost Downboat if the relevant post is deleted or marked as false positive before the 2-minute window is up.
Please note that the usage of deletion commands is discouraged in Charcoal HQ. Generally, messages in CHQ are kept as a record of all reported posts for multiple reasons:
- While we do have metasmoke which acts as a mirror of all posts, it does go offline occasionally
- Some userscripts which run in chat (e.g. FIRE) use information from the chat reports to fetch the correct data from the API.
- It allows for a second opinion on reports, even if one person has marked it as a false positive
- Seeing spam and abusive posts is an occupational hazard in CHQ; we aren't worried if the report contains something NSFW.
delete-force command can be used if a report really needs to be deleted in Charcoal HQ.
You can now use a shortcut to post a reply to one, two or three messages at the same time, in this shape:
sd cmd1 sd cmd1 cmd2 sd cmd1 cmd2 cmd3 sd cmd1 cmd2 cmd3 cmd4 sd cmd1 cmd2 cmd3 cmd4 cmd5
cmd1 will be invoked in the most recent message, cmd2 on the message before that and cmd3 on the message before that, and so on.
It's also possible to skip a message. Replace a command with a
- to skip a
message. For example,
sd - delete skips the most recent message and
deletes the message before that one.
Smokey will reply to your shortcut command unless all commands have quiet mode (like tp-) or just don't reply by default (like delete).
A few examples:
sd - deletekeeps the most recent message and deletes the one before that.
sd tp fp deletemarks the most recent message as tp, the one before that as fp, and deletes the one before that.
You can also put a digit in front of a command so that the command will apply as many times as the digit. A few examples:
sd tpu tpu
sd 2tpu 3fpu=
sd tpu tpu fpu fpu fpu
sd 2- fp=
sd - - fp