Reference

Command reference

Every command KeyBot provides. Commands your members use are staying exactly as they are. The eleven server-management commands are being retired, and this page says which ones and what replaces them.

The short version
  • Nothing your members use is changing. /claim, /keys, /pools, /docs, /info, and /invite are staying.
  • Neither grant command is changing. /grant and /grantrole are staying.
  • Eleven management commands are being removed and their features now live in the dashboard.

Member commands

Anyone in the server can run these. They are not changing and are not being removed.

CommandOptionsWhat it does
/claimpoolClaim a key from a public pool. Checks bans, required roles, and the per-member limit first. The reply is only visible to the person who ran it.
/keysnoneList every key you have claimed, across every server, grouped by game. Works only in KeyBot's direct messages, not in a server.
/poolsnonePage through this server's pools with their game, visibility, key type, claim limit, stock, and required roles.
/infononeBot version and useful links.
/invitenoneThe link to add KeyBot to another server. Works in servers and in DMs.
/docsnoneA link to this documentation.

Moderator commands

For handing keys out by hand. These are staying. They are not part of the move to the dashboard.

CommandOptionsWho can run itWhat it does
/grantuser, poolThe pool's moderator rolesSend one key from the pool to a member by direct message. Respects the pool's keys-per-member limit. The pool must have at least one moderator role configured.
/grantrolerole, poolManage ServerGive one key to every member holding a role, after a confirmation showing the member count against the stock available. Does not check the per-member limit.

Management commands, being removed

These eleven commands are deprecatedThey still work today, and each one now replies with a notice pointing at the dashboard. They will be removed in a future release. Everything they do is available in the dashboard, which is where new work is going. Nothing is lost: your pools, keys, bans, and settings are the same data, reached a different way.

All of these require the Manage Server permission.

CommandOptionsWhat it doesNow in the dashboard under
/createsimple with name, game, key_type, private, amount, or builder for a step-by-step versionCreate a pool.Pools
/editpool, option (name, game, privacy, amount, key type)Change one setting on a pool.Pools
/deletepoolDelete a pool, with a confirmation. Its keys and pool bans go with it.Pools
/pool infopoolDetailed view of one pool, including stock and whether a low-stock warning has been sent.Pools
/importpool, keys (file attachment)Bulk load keys into a pool from a file.Keys
/exportpoolDownload the pool's unclaimed keys as a .txt file.Keys
/lookupuser or keyFind every key a member claimed here, or trace a single key back to whoever has it.Keys
/bansadd pool|guild, remove pool|guild, list [pool]Ban and unban members from one pool or from the whole server, and list current bans.Bans
/roleadd, remove, each with pool and roleManage the roles required to claim from a pool.Roles
/modpool add, pool remove, set, disableManage a pool's moderator roles. The server-wide set and disable subcommands are legacy and do not affect who can grant keys.Roles
/channelsset or remove, with type of logs or warningsChoose where import and grant logs go, and where low-stock warnings go. Setting a channel posts a test message into it first, so a permission problem shows up immediately.Settings

Why they are going

Slash commands are a poor fit for management work. Editing a pool means one command per field, a ban list has to be paged through twenty at a time, and a long key file is awkward to attach and impossible to review before it lands. The dashboard shows the whole picture at once and lets you check what you are about to do before you do it.

Claiming, by contrast, belongs in Discord. That is where your members already are, and it is one command that does one thing. So the member-facing commands stay, and the grant commands stay with them, because handing a key to someone you are already talking to should not mean opening a browser.