PluralKit/docs/content/command-list.md

---
layout: default
title: Command List
permalink: /commands
description: The full list of all commands in PluralKit, and a short description of what they do.
nav_order: 3
---

# How to read this
Words in **\<angle brackets>** or **[square brackets]** mean fill-in-the-blank. Square brackets mean this is optional. Don't include the actual brackets.

## Special arguments
Some arguments indicate the use of specific Discord features. These include:

- `@mention`: insert a Discord mention (or "ping")

::: details Mention example
![Mention example](./assets/mention_arg.png)
:::

- `reply`: reply to a previous message

::: details Message reply example
![Message reply example](./assets/reply_arg.png)
:::

- `upload`: upload a file

::: details Upload example
![Upload example](./assets/upload_arg.png)
:::

# Commands
## System commands
*Optionally replace `[system]` with a @mention, Discord account ID, or 5-character ID. For most commands, adding `-clear` will clear/delete the field.*
- `pk;system [system]` - Shows information about a system.
- `pk;system new [name]` - Creates a new system registered to your account.
- `pk;system [system] rename [new name]` - Changes the name of your system.
- `pk;system [system] description [description]` - Changes the description of your system.
- `pk;system [system] avatar [avatar url|@mention|upload]` - Changes the avatar of your system.
- `pk;system [system] banner [image url|upload]` - Changes your system's banner image.
- `pk;system [system] privacy` - Displays your system's current privacy settings.
- `pk;system [system] privacy <subject> <public|private>` - Changes your systems privacy settings.
- `pk;system [system] tag [tag]` - Changes the system tag of your system.
- `pk;system [system] servertag [tag|-enable|-disable]` - Changes your system's tag in the current server, or disables it for the current server.
- `pk;system [system] pronouns [pronouns]` - Changes the pronouns of your system.
- `pk;system proxy [server id] [on|off]` - Toggles message proxying for a specific server.
- `pk;system [system] delete` - Deletes your system.
- `pk;system [system] fronter` - Shows the current fronter of a system.
- `pk;system [system] fronthistory` - Shows the last 10 fronters of a system.
- `pk;system [system] frontpercent [timeframe]` - Shows the aggregated front history of a system within a given time frame.
- `pk;system [system] list` - Shows a paginated list of a system's members.
- `pk;system [system] list -full` - Shows a paginated list of a system's members, with increased detail.
- `pk;find <search term>` - Searches members by name.
- `pk;system [system] find <search term>` - (same as above, but for a specific system)

## Member commands
*Replace `<member>` with a member's name, 5-character ID or display name. For most commands, adding `-clear` will clear/delete the field.*
- `pk;member <member>` - Shows information about a member.
- `pk;member new <name>` - Creates a new system member.
- `pk;member <member> rename <new name>` - Changes the name of a member.
- `pk;member <member> displayname <new display name>` - Changes the display name of a member.
- `pk;member <member> servername <new server name>` - Changes the display name of a member, only in the current server.
- `pk;member <member> description [description]` - Changes the description of a member.
- `pk;member <member> avatar [avatar url|@mention|upload]` - Changes the avatar of a member.
- `pk;member <member> serveravatar [avatar url|@mention|upload]` - Changes the avatar of a member in a specific server.
- `pk;member <name> banner [image url|upload]` - Changes the banner image of a member.
- `pk;member <member> privacy` - Displays a members current privacy settings.
- `pk;member <member> privacy <subject> <public|private>` - Changes a members privacy setting.
- `pk;member <member> proxy [tags]` - Changes the proxy tags of a member. use below add/remove commands for members with multiple tag pairs.
- `pk;member <member> proxy add [tags]` - Adds a proxy tag pair to a member.
- `pk;member <member> proxy remove [tags]` - Removes a proxy tag from a member.
- `pk;member <member> autoproxy [on|off]` - Sets whether a member will be autoproxied when autoproxy is set to latch or front mode.
- `pk;member <member> keepproxy [on|off]` - Sets whether to include a member's proxy tags in the proxied message.
- `pk;member <member> pronouns [pronouns]` - Changes the pronouns of a member.
- `pk;member <member> color [color]` - Changes the color of a member.
- `pk;member <member> birthdate [birthdate|today]` - Changes the birthday of a member.
- `pk;member <member> delete` - Deletes a member.

## Group commands
*Replace `<group>` with a group's name, 5-character ID or display name. For most commands, adding `-clear` will clear/delete the field.*
- `pk;group <group>` - Shows information about a group.
- `pk;group new <name>` - Creates a new group.
- `pk;group list` - Lists all groups in your system.
- `pk;group <group> list` - Lists all members in a group.
- `pk;group <group> random` - Shows the info card of a randomly selected member in a group.
- `pk;group <group> rename <new name>` - Renames a group.
- `pk;group <group> displayname [display name]` - Shows or changes a group's display name.
- `pk;group <group> description [description]` - Shows or changes a group's description.
- `pk;group <group> add <member> [member 2] [member 3...]` - Adds one or more members to a group.
- `pk;group <group> remove <member> [member 2] [member 3...]` - Removes one or more members from a group.
- `pk;group <group> privacy <name|description|icon|visibility|metadata|all> <public|private>` - Changes a group's privacy settings.
- `pk;group <group> icon [icon url|@mention|upload]` - Shows or changes a group's icon.
- `pk;group <group> banner [image url|upload]` - Shows or changes a group's banner image.
- `pk;group <group> delete` - Deletes a group.

## Switching commands
- `pk;switch [member...]` - Registers a switch with the given members.
- `pk;switch out` - Registers a 'switch-out' - a switch with no associated members.
- `pk;switch edit <member...|out>` - Edits the members in the latest switch. 
- `pk;switch move <time>` - Moves the latest switch backwards in time.
- `pk;switch delete` - Deletes the latest switch.
- `pk;switch delete all` - Deletes all logged switches.

## Autoproxy commands
- `pk;autoproxy off` - Disables autoproxying for your system in the current server.
- `pk;autoproxy front` - Sets your system's autoproxy in this server to proxy the first member currently registered as front.
- `pk;autoproxy latch` - Sets your system's autoproxy in this server to proxy the last manually proxied member.
- `pk;autoproxy \<member>` - Sets your system's autoproxy in this server to proxy a specific member.

## Config commands
- `pk;config timezone [location]` - Changes the time zone of your system.
- `pk;config ping <enable|disable>` - Changes your system's ping preferences.
- `pk;config autoproxy timeout [<duration>|off|reset]` - Sets the latch timeout duration for your system.
- `pk;config autoproxy account [on|off]` - Toggles autoproxy globally for the current account.

## Server owner commands
*(all commands here require Manage Server permission)*
- `pk;log channel` - Shows the currently set log channel
- `pk;log channel <channel>` - Sets the given channel to log all proxied messages.
- `pk;log channel -clear` - Clears the currently set log channel.
- `pk;log disable <#channel> [#channel...]` - Disables logging messages posted in the given channel(s) (useful for staff channels and such).
- `pk;log enable <#channel> [#channel...]` - Re-enables logging messages posted in the given channel(s).
- `pk;logclean <on|off>` - Enables or disables [log cleanup](/staff/compatibility/#log-cleanup).
- `pk;blacklist add <#channel> [#channel...]` - Adds the given channel(s) to the proxy blacklist (proxying will be disabled here)
- `pk;blacklist remove <#channel> [#channel...]` - Removes the given channel(s) from the proxy blacklist.

## Utility
- `pk;random [-group]` - Shows the info card of a randomly selected member [or group] in your system.
- `pk;message <message id|message link|reply>` - Looks up information about a proxied message by its message ID or link.
- `pk;invite` - Sends the bot invite link for PluralKit.
- `pk;import` - Imports a data file from PluralKit or Tupperbox.
- `pk;export` - Exports a data file containing your system information.
- `pk;debug permissions [server id]` - [Checks the given server's permission setup](/staff/permissions/#permission-checker-command) to check if it's compatible with PluralKit.
- `pk;debug proxying <message link|reply>` - Checks why your message has not been proxied.
- `pk;edit [message link|reply] <new content>` - Edits a proxied message. Without an explicit message target, will target the last message proxied by your system in the current channel. **Does not support message IDs!**
- `pk;reproxy [message link|reply] <member name|ID>` - Reproxies a message using a different member. Without an explicit message target, will target the last message proxied by your system in the current channel.
- `pk;link <account>` - Links your system to a different account.
- `pk;unlink [account]` - Unlinks an account from your system.

## API
*(for using the [PluralKit API](/api), useful for developers)*
- `pk;token` - DMs you a token for using the PluralKit API.
- `pk;token refresh` - Refreshes your API token and invalidates the old one.
- `pk;s webhook [url]` - Shows or updates the [dispatch webhook](/api/dispatch) URL for your system.

## Help
- `pk;help` - Displays a basic help message describing how to use the bot.
- `pk;help proxy` - Directs you to [this page](/guide/#proxying).
- `pk;system help` - Lists system-related commands.
- `pk;member help` - Lists member-related commands.
- `pk;switch help` - Lists switch-related commands.
- `pk;commands` - Shows inline command documentation, or directs you to this page.
Add basic documentation site 2019-07-03 08:25:17 +00:00			`---`
			`layout: default`
			`title: Command List`
			`permalink: /commands`
Various minor site/documentation changes 2019-08-31 10:32:28 +00:00			`description: The full list of all commands in PluralKit, and a short description of what they do.`
Improve Docs (#151) * Added configurable command prefix * Added getting started, renamed files * Add nav order, add assests, add system example * Added a lot * Update Emojis * Add guide links to bot * Added Images 2020-02-09 13:17:26 +00:00			`nav_order: 3`
Add basic documentation site 2019-07-03 08:25:17 +00:00			`---`

			`# How to read this`
Update command list documentation 2020-03-04 17:28:13 +00:00			`Words in \<angle brackets> or [square brackets] mean fill-in-the-blank. Square brackets mean this is optional. Don't include the actual brackets.`
Add basic documentation site 2019-07-03 08:25:17 +00:00
Update documentation (#332) Co-authored-by: Petal Rose <habonimkef@gmail.com> 2021-06-02 23:50:45 +00:00			`## Special arguments`
			`Some arguments indicate the use of specific Discord features. These include:`

			- `@mention`: insert a Discord mention (or "ping")

			`::: details Mention example`
			`![Mention example](./assets/mention_arg.png)`
			`:::`

			- `reply`: reply to a previous message

			`::: details Message reply example`
			`![Message reply example](./assets/reply_arg.png)`
			`:::`

			- `upload`: upload a file

			`::: details Upload example`
			`![Upload example](./assets/upload_arg.png)`
			`:::`

Add basic documentation site 2019-07-03 08:25:17 +00:00			`# Commands`
			`## System commands`
Update command list documentation 2020-03-04 17:28:13 +00:00			Optionally replace `[system]` with a @mention, Discord account ID, or 5-character ID. For most commands, adding `-clear` will clear/delete the field.
Minor layout/content tweaks 2020-07-28 16:47:26 +00:00			- `pk;system [system]` - Shows information about a system.
fix: incorrect documentation for pk;system new 2021-12-07 07:13:04 +00:00			- `pk;system new [name]` - Creates a new system registered to your account.
feat: clean up command parsing for pk;system 2021-12-05 22:21:31 +00:00			- `pk;system [system] rename [new name]` - Changes the name of your system.
			- `pk;system [system] description [description]` - Changes the description of your system.
			- `pk;system [system] avatar [avatar url\|@mention\|upload]` - Changes the avatar of your system.
			- `pk;system [system] banner [image url\|upload]` - Changes your system's banner image.
			- `pk;system [system] privacy` - Displays your system's current privacy settings.
			- `pk;system [system] privacy <subject> <public\|private>` - Changes your systems privacy settings.
			- `pk;system [system] tag [tag]` - Changes the system tag of your system.
			- `pk;system [system] servertag [tag\|-enable\|-disable]` - Changes your system's tag in the current server, or disables it for the current server.
feat: system pronouns (#429) 2022-03-23 18:20:16 +00:00			- `pk;system [system] pronouns [pronouns]` - Changes the pronouns of your system.
allow pk;system proxy to take a server ID So people can disable proxying in a server without outing themselves :) 2021-04-06 04:25:13 +00:00			- `pk;system proxy [server id] [on\|off]` - Toggles message proxying for a specific server.
feat: clean up command parsing for pk;system 2021-12-05 22:21:31 +00:00			- `pk;system [system] delete` - Deletes your system.
Update command list documentation 2020-03-04 17:28:13 +00:00			- `pk;system [system] fronter` - Shows the current fronter of a system.
			- `pk;system [system] fronthistory` - Shows the last 10 fronters of a system.
			- `pk;system [system] frontpercent [timeframe]` - Shows the aggregated front history of a system within a given time frame.
			- `pk;system [system] list` - Shows a paginated list of a system's members.
Add pk;find to the command list 2020-03-05 18:08:11 +00:00			- `pk;system [system] list -full` - Shows a paginated list of a system's members, with increased detail.
			- `pk;find <search term>` - Searches members by name.
			- `pk;system [system] find <search term>` - (same as above, but for a specific system)
Update command list documentation 2020-03-04 17:28:13 +00:00
Add basic documentation site 2019-07-03 08:25:17 +00:00			`## Member commands`
Clarify member/group argument in command list Co-authored-by: Powi <powi@powi.fr> 2021-06-11 21:12:58 +00:00			Replace `<member>` with a member's name, 5-character ID or display name. For most commands, adding `-clear` will clear/delete the field.
			- `pk;member <member>` - Shows information about a member.
Add command list and API documentation 2019-07-03 09:44:57 +00:00			- `pk;member new <name>` - Creates a new system member.
Clarify member/group argument in command list Co-authored-by: Powi <powi@powi.fr> 2021-06-11 21:12:58 +00:00			- `pk;member <member> rename <new name>` - Changes the name of a member.
			- `pk;member <member> displayname <new display name>` - Changes the display name of a member.
			- `pk;member <member> servername <new server name>` - Changes the display name of a member, only in the current server.
			- `pk;member <member> description [description]` - Changes the description of a member.
			- `pk;member <member> avatar [avatar url\|@mention\|upload]` - Changes the avatar of a member.
			- `pk;member <member> serveravatar [avatar url\|@mention\|upload]` - Changes the avatar of a member in a specific server.
Add banner (large) image 2021-08-02 17:46:12 +00:00			- `pk;member <name> banner [image url\|upload]` - Changes the banner image of a member.
Clarify member/group argument in command list Co-authored-by: Powi <powi@powi.fr> 2021-06-11 21:12:58 +00:00			- `pk;member <member> privacy` - Displays a members current privacy settings.
			- `pk;member <member> privacy <subject> <public\|private>` - Changes a members privacy setting.
			- `pk;member <member> proxy [tags]` - Changes the proxy tags of a member. use below add/remove commands for members with multiple tag pairs.
			- `pk;member <member> proxy add [tags]` - Adds a proxy tag pair to a member.
			- `pk;member <member> proxy remove [tags]` - Removes a proxy tag from a member.
			- `pk;member <member> autoproxy [on\|off]` - Sets whether a member will be autoproxied when autoproxy is set to latch or front mode.
			- `pk;member <member> keepproxy [on\|off]` - Sets whether to include a member's proxy tags in the proxied message.
			- `pk;member <member> pronouns [pronouns]` - Changes the pronouns of a member.
			- `pk;member <member> color [color]` - Changes the color of a member.
feat: add "today" argument to pk;m birthday (#398) 2021-10-29 21:44:51 +00:00			- `pk;member <member> birthdate [birthdate\|today]` - Changes the birthday of a member.
Clarify member/group argument in command list Co-authored-by: Powi <powi@powi.fr> 2021-06-11 21:12:58 +00:00			- `pk;member <member> delete` - Deletes a member.
Update command list documentation 2020-03-04 17:28:13 +00:00
Document group commands 2020-10-04 07:12:40 +00:00			`## Group commands`
Clarify member/group argument in command list Co-authored-by: Powi <powi@powi.fr> 2021-06-11 21:12:58 +00:00			Replace `<group>` with a group's name, 5-character ID or display name. For most commands, adding `-clear` will clear/delete the field.
			- `pk;group <group>` - Shows information about a group.
Document group commands 2020-10-04 07:12:40 +00:00			- `pk;group new <name>` - Creates a new group.
			- `pk;group list` - Lists all groups in your system.
			- `pk;group <group> list` - Lists all members in a group.
Move member random to Random.cs, add group random and group member random 2020-11-22 16:58:23 +00:00			- `pk;group <group> random` - Shows the info card of a randomly selected member in a group.
Document group commands 2020-10-04 07:12:40 +00:00			- `pk;group <group> rename <new name>` - Renames a group.
			- `pk;group <group> displayname [display name]` - Shows or changes a group's display name.
			- `pk;group <group> description [description]` - Shows or changes a group's description.
			- `pk;group <group> add <member> [member 2] [member 3...]` - Adds one or more members to a group.
			- `pk;group <group> remove <member> [member 2] [member 3...]` - Removes one or more members from a group.
feat: rework group list into member list 2022-01-15 03:30:02 +00:00			- `pk;group <group> privacy <name\|description\|icon\|visibility\|metadata\|all> <public\|private>` - Changes a group's privacy settings.
Update documentation (#332) Co-authored-by: Petal Rose <habonimkef@gmail.com> 2021-06-02 23:50:45 +00:00			- `pk;group <group> icon [icon url\|@mention\|upload]` - Shows or changes a group's icon.
Add banner (large) image 2021-08-02 17:46:12 +00:00			- `pk;group <group> banner [image url\|upload]` - Shows or changes a group's banner image.
Document group commands 2020-10-04 07:12:40 +00:00			- `pk;group <group> delete` - Deletes a group.

Add command list and API documentation 2019-07-03 09:44:57 +00:00			`## Switching commands`
			- `pk;switch [member...]` - Registers a switch with the given members.
Add switch editing functionality 2021-09-27 00:08:38 +00:00			- `pk;switch out` - Registers a 'switch-out' - a switch with no associated members.
			- `pk;switch edit <member...\|out>` - Edits the members in the latest switch.
Add command list and API documentation 2019-07-03 09:44:57 +00:00			- `pk;switch move <time>` - Moves the latest switch backwards in time.
			- `pk;switch delete` - Deletes the latest switch.
Tweak description for `switch delete all` command 2020-11-19 23:05:53 +00:00			- `pk;switch delete all` - Deletes all logged switches.
Update command list documentation 2020-03-04 17:28:13 +00:00
Add documentation on the website as well 2020-11-21 01:52:15 +00:00			`## Autoproxy commands`
feat: update command help for pk;autoproxy 2022-01-19 22:40:27 +00:00			- `pk;autoproxy off` - Disables autoproxying for your system in the current server.
			- `pk;autoproxy front` - Sets your system's autoproxy in this server to proxy the first member currently registered as front.
			- `pk;autoproxy latch` - Sets your system's autoproxy in this server to proxy the last manually proxied member.
			- `pk;autoproxy \<member>` - Sets your system's autoproxy in this server to proxy a specific member.
feat: pk;config 2021-11-30 02:35:21 +00:00
			`## Config commands`
			- `pk;config timezone [location]` - Changes the time zone of your system.
			- `pk;config ping <enable\|disable>` - Changes your system's ping preferences.
			- `pk;config autoproxy timeout [<duration>\|off\|reset]` - Sets the latch timeout duration for your system.
			- `pk;config autoproxy account [on\|off]` - Toggles autoproxy globally for the current account.
Add documentation on the website as well 2020-11-21 01:52:15 +00:00
Update command list documentation 2020-03-04 17:28:13 +00:00			`## Server owner commands`
			`(all commands here require Manage Server permission)`
feat: misc pk;log channel changes - show currently set log channel if no arguments are present - throw error if someone tries to set the log channel to an invalid channel type - throw error if bot is missing permissions to log in the new channel 2021-10-29 17:28:27 +00:00			- `pk;log channel` - Shows the currently set log channel
Update command list documentation 2020-03-04 17:28:13 +00:00			- `pk;log channel <channel>` - Sets the given channel to log all proxied messages.
Clean up member list commands and log commands, as well as related docs 2020-11-19 22:10:59 +00:00			- `pk;log channel -clear` - Clears the currently set log channel.
Update command list documentation 2020-03-04 17:28:13 +00:00			- `pk;log disable <#channel> [#channel...]` - Disables logging messages posted in the given channel(s) (useful for staff channels and such).
			- `pk;log enable <#channel> [#channel...]` - Re-enables logging messages posted in the given channel(s).
fix(docs): broken links 2021-12-07 07:42:22 +00:00			- `pk;logclean <on\|off>` - Enables or disables [log cleanup](/staff/compatibility/#log-cleanup).
Update command list documentation 2020-03-04 17:28:13 +00:00			- `pk;blacklist add <#channel> [#channel...]` - Adds the given channel(s) to the proxy blacklist (proxying will be disabled here)
			- `pk;blacklist remove <#channel> [#channel...]` - Removes the given channel(s) from the proxy blacklist.

Add command list and API documentation 2019-07-03 09:44:57 +00:00			`## Utility`
Move member random to Random.cs, add group random and group member random 2020-11-22 16:58:23 +00:00			- `pk;random [-group]` - Shows the info card of a randomly selected member [or group] in your system.
Update documentation (#332) Co-authored-by: Petal Rose <habonimkef@gmail.com> 2021-06-02 23:50:45 +00:00			- `pk;message <message id\|message link\|reply>` - Looks up information about a proxied message by its message ID or link.
Add command list and API documentation 2019-07-03 09:44:57 +00:00			- `pk;invite` - Sends the bot invite link for PluralKit.
			- `pk;import` - Imports a data file from PluralKit or Tupperbox.
Fix typo in command list 2019-07-15 15:37:34 +00:00			- `pk;export` - Exports a data file containing your system information.
fix(docs): broken links 2021-12-07 07:42:22 +00:00			- `pk;debug permissions [server id]` - [Checks the given server's permission setup](/staff/permissions/#permission-checker-command) to check if it's compatible with PluralKit.
feat: proxy debug command Co-authored-by: Spectralitree <72747870+Spectralitree@users.noreply.github.com> 2021-08-04 01:06:14 +00:00			- `pk;debug proxying <message link\|reply>` - Checks why your message has not been proxied.
Update documentation (#332) Co-authored-by: Petal Rose <habonimkef@gmail.com> 2021-06-02 23:50:45 +00:00			- `pk;edit [message link\|reply] <new content>` - Edits a proxied message. Without an explicit message target, will target the last message proxied by your system in the current channel. Does not support message IDs!
feat: add `pk;reproxy` (#447) 2022-05-08 21:10:07 +00:00			- `pk;reproxy [message link\|reply] <member name\|ID>` - Reproxies a message using a different member. Without an explicit message target, will target the last message proxied by your system in the current channel.
feat: clean up command parsing for pk;system 2021-12-05 22:21:31 +00:00			- `pk;link <account>` - Links your system to a different account.
			- `pk;unlink [account]` - Unlinks an account from your system.
Update command list documentation 2020-03-04 17:28:13 +00:00
Add command list and API documentation 2019-07-03 09:44:57 +00:00			`## API`
fix(docs): broken links 2021-12-07 07:42:22 +00:00			`(for using the [PluralKit API](/api), useful for developers)`
Add command list and API documentation 2019-07-03 09:44:57 +00:00			- `pk;token` - DMs you a token for using the PluralKit API.
			- `pk;token refresh` - Refreshes your API token and invalidates the old one.
feat(webhooks): add documentation for pk;s webhook command 2021-11-25 20:42:25 +00:00			- `pk;s webhook [url]` - Shows or updates the [dispatch webhook](/api/dispatch) URL for your system.
Update command list documentation 2020-03-04 17:28:13 +00:00
Add command list and API documentation 2019-07-03 09:44:57 +00:00			`## Help`
			- `pk;help` - Displays a basic help message describing how to use the bot.
fix(docs): broken links 2021-12-07 07:42:22 +00:00			- `pk;help proxy` - Directs you to [this page](/guide/#proxying).
Update command list documentation 2020-03-04 17:28:13 +00:00			- `pk;system help` - Lists system-related commands.
			- `pk;member help` - Lists member-related commands.
			- `pk;switch help` - Lists switch-related commands.
Update documentation (#332) Co-authored-by: Petal Rose <habonimkef@gmail.com> 2021-06-02 23:50:45 +00:00			- `pk;commands` - Shows inline command documentation, or directs you to this page.