hackclub / orpheus-bot

⚠️ GitHub & Heroku have turned off their integration while investigating a breach, so changes will not automatically deploy after pushing to main. If you have access to do so, please push your changes to the main branch of the Heroku git remote once your PR is merged. Otherwise, please mention it in the PR and assign @maxwofford or @sampoder for review.

• Commands
  • Legend
  • Slash Commands
    • Anyone ‡
    • Full Slack Users §
    • Club leaders Δ
    • Slack Owner/Admin ◊
  • Message commands
    • Anyone ‡
    • Club leaders Δ
    • Slack Owner/Admin ◊
• Misc Interactions

Commands

Legend

‡ = anyone
§ = full Slack user only (not multi-channel or single-channel guest)
Δ = club leader only
◊ = Slack owner/admin only
† = deprecated

Slash Commands

Every Slash command comes with a help message. For example, to learn to use /stats, type /stats help in Slack.

Anyone ‡

• ‡/airtable Post the database links of a Slack user
• ‡/address /leader-address Post the current user's address with a link to edit
• ‡/stats @USER Get tagged user's meeting stats
• ‡/stats #CHANNEL Get tagged channel's meeting stats
• ‡/get See a list of available promotions
  • † ‡/get notion premium Get a Premium Notion account
  • † ‡/get adafruit discount Get a discount code for Adafruit
• ‡/report File a misconduct report
• † ‡/som-report Report a Slack user's behavior
• † ‡/promo Renamed to /get

‡ = anyone
† = deprecated

Full Slack Users §

This excludes Slack guests, such as multi-channel or single-channel users.

• §/som-lookup Lookup who promoted a multi-channel guest to a full Slack user during the Summer of Making.
• † §/som-invite Invite a multi-channel guest for the Summer of Making.
• † §/club-init Become a club leader by creating a club

§ = full Slack user only (not multi-channel or single-channel guest)
† = deprecated

Club leaders Δ

• Δ/club-address Post the current user's club address with a link to edit
• Δ/rename-channel Rename your club channel
• Δ/slack-invite Get custom club Slack invite link & optionally invite an email to Slack
• Δ/moderate Use this command to moderate your club's community channel, first run /moderate to link the channel and then /moderate <slack message link> to delete an inappropriate message. WIP.
• Δ/meeting-add Add a meeting to your club's stats
• Δ/meeting-remove Remove a mis-recorded meeting
• Δ/meeting-list Get a list of club meetings (useful for /meeting-remove)
• Δ/meeting-stats /stats Get current user's meeting stats
  • ‡/stats @USER Get tagged user's meeting stats
  • ‡/stats #CHANNEL Get tagged channel's meeting stats
• Δ/orpheus-tutorial /meeting-tutorial
  • Use @orpheus forget before running the command to restart the tutorial from scratch
• Δ/leader-add @USER Add another Slack user as a leader for your club
• Δ/leader-list Print out the Slack accounts of registered co-leads
• ‡/get See a list of available promotions
  • † Δ/get zoom pro Upgrade to a Zoom Pro account. Deprecated in favor of https://github.com/hackclub/slash-z
  • † Δ/get hack pack Add club to list of Hack Pack approved clubs
  • Δ/get sticker envelope Order a sticker envelope for yourself or another slack user
  • Δ/get stickermule Request credit on StickerMule
  • † Δ/get github grant Request a $100 grant for your club, paid by GitHub
• † Δ/club-card Issue a credit card number for your club
• † Δ/meeting-time Set the meeting time to get meeting notifications weekly

Δ = club leader only
‡ = anyone
† = deprecated

Slack Owner/Admin ◊

• ◊/announcement Send an announcement to all clubs in Airtable queued for announcements
  • ◊/announcement address See a list of the enqueued clubs
  • ◊/announcement status Get the number of successful messages sent / the total messages to send
  • ◊/announcement send Start sending announcements to enqueued clubs
  • ◊/announcement record Record a Slack message to the announcement buffer
• ◊/som-promote @USER Promote a multi-channel guest to a full Slack user.
• † ◊/som-ban Deactivate a Slack user

Δ = club leader only
† = deprecated

Message commands

Anyone ‡

• ‡@orpheus breakout creates an ephemeral channel based on the current channel
• ‡@orpheus info Print the current uptime (used as a startup message)
• ‡@orpheus forget Deletes a Slack user from @orpheus' memory. Used for debugging.
• ‡@orpheus find or create @USER Finds or creates a user record in the Airtable database. Used by automations.
• ‡@orpheus date Command that returns a parsed date. Used for debugging.

‡ = anyone

Club leaders Δ

• † Δ@orpheus checkin Start a check-in with the current user

Δ = club leader only
† = deprecated

Slack Owner/Admin ◊

• ◊thump Trigger scheduled tasks (ex. close inactive breakout channels)
• ◊@orpheus dm Send a message as @orpheus
  • ◊@orpheus dm @USER Hello world Send a DM to @USER of "Hello world"
  • ◊@orpheus dm #CHANNEL Hello world Send a DM to #CHANNEL of "Hello world"
• ◊@orpheus add this team to the leaders channel Use in a club channel to invite all associated leader to the private #leaders channel

◊ = Slack owner/admin only

Misc Interactions

• Posting files in the #cdn channel will host them on a cdn link
• Mentioning @orpheus in a message that contains thanks/thank you/thnx etc. will trigger a response
• Mentioning @orpheus in a message that contains who are you etc. will trigger a response
• Mentioning @orpheus in a message that contains where are you etc. will trigger a response
• Mentioning @orpheus in a message that contains what are you doing etc. causes orpheus to shrug
• Mentioning hacktoberfest in a message will trigger an ephemeral response to the user (but only in Oct)
• Mentioning @orpheus in a message that contains hello will trigger a response
• Mentioning @orpheus in a message that contains sass or mock will trigger a sassy response
• Asking what are you doing in a message @orpheus is tagged in will trigger a response
• Tagging @orpheus in a message that doesn't map to an existing interaction will trigger a confused response
• The phrase get a room in a post or thread will trigger the breakout commmand