2019-07-03 08:25:17 +00:00
---
layout: default
title: Command List
permalink: /commands
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.
2020-02-09 13:17:26 +00:00
nav_order: 3
2019-07-03 08:25:17 +00:00
---
# How to read this
2019-08-31 10:32:28 +00:00
Words in \<angle brackets> are *required parameters* . Words in [square brackets] are *optional parameters* . Words with ellipses... indicate multiple repeating parameters. Note that **you should not include the brackets in the actual command** .
2019-07-03 08:25:17 +00:00
# Commands
## System commands
2019-07-03 09:44:57 +00:00
- `pk;system [id]` - Shows information about a system.
- `pk;system new [name]` - Creates a new system registered to your account.
2019-08-09 10:55:15 +00:00
- `pk;system rename [new name]` - Changes the name of your system.
2019-07-03 09:44:57 +00:00
- `pk;system description [description]` - Changes the description of your system.
- `pk;system avatar [avatar url]` - Changes the avatar of your system.
- `pk;system tag [tag]` - Changes the system tag of your system.
- `pk;system timezone [location]` - Changes the time zone of your system.
2019-12-22 13:26:53 +00:00
- `pk;system proxy [on|off]` - Toggles message proxying for a specific server.
2019-07-03 09:44:57 +00:00
- `pk;system delete` - Deletes your system.
- `pk;system [id] fronter` - Shows the current fronter of a system.
- `pk;system [id] fronthistory` - Shows the last 10 fronters of a system.
- `pk;system [id] frontpercent [timeframe]` - Shows the aggregated front history of a system within a given time frame.
- `pk;system [id] list` - Shows a paginated list of a system's members.
- `pk;system [id] list full` - Shows a paginated list of a system's members, with increased detail.
2020-01-25 15:21:52 +00:00
- `pk;autoproxy [off|front|latch|member]` - Updates the system's autoproxy settings for a given server.
2019-07-03 09:44:57 +00:00
- `pk;link <account>` - Links this system to a different account.
- `pk;unlink [account]` - Unlinks an account from this system.
2019-07-03 08:25:17 +00:00
## Member commands
2019-07-03 09:44:57 +00:00
- `pk;member <name>` - Shows information about a member.
- `pk;member new <name>` - Creates a new system member.
- `pk;member <name> rename <new name>` - Changes the name of a member.
2019-08-09 08:34:41 +00:00
- `pk;member <name> displayname <new display name>` - Changes the display name of a member.
2019-12-27 10:43:18 +00:00
- `pk;member <name> servername <new server name>` - Changes the display name of a member, only in the current serve.
2019-08-09 08:34:41 +00:00
- `pk;member <name> description [description]` - Changes the description of a member.
2019-12-28 11:23:52 +00:00
- `pk;member <name> avatar <avatar url|@mention|clear>` - Changes the avatar of a member.
2020-02-12 16:42:12 +00:00
- `pk;member <name> serveravatar <avatar url|@mention|clear>` - Changes the avatar of a member in a specific server.
2019-10-28 19:15:27 +00:00
- `pk;member <name> proxy [tags]` - Changes the proxy tags of a member. use below add/remove commands for members with multiple tag pairs.
- `pk;member <name> proxy add [tags]` - Adds a proxy tag pair to a member.
- `pk;member <name> proxy remove [tags]` - Removes a proxy tag from a member.
2019-10-30 12:59:22 +00:00
- `pk;member <name> keepproxy [on|off]` - Sets whether to include a member's proxy tags in the proxied message.
2019-07-03 09:44:57 +00:00
- `pk;member <name> pronouns [pronouns]` - Changes the pronouns of a member.
- `pk;member <name> color [color]` - Changes the color of a member.
- `pk;member <name> birthdate [birthdate]` - Changes the birthday of a member.
2019-07-27 04:31:21 +00:00
- `pk;member <name> delete` - Deletes a member.
2020-01-25 15:40:03 +00:00
- `pk;random` - Shows the member card of a randomly selected member in your system.
2019-07-03 09:44:57 +00:00
## Switching commands
- `pk;switch [member...]` - Registers a switch with the given members.
- `pk;switch move <time>` - Moves the latest switch backwards in time.
- `pk;switch delete` - Deletes the latest switch.
2019-11-02 21:46:51 +00:00
- `pk;switch delete all` - Deletes every logged switch.
2019-07-03 09:44:57 +00:00
- `pk;switch out` - Registers a 'switch-out' - a switch with no associated members.
## Utility
- `pk;log <channel>` - Sets the channel to log all proxied messages.
- `pk;message <message id>` - Looks up information about a proxied message by its message ID.
- `pk;invite` - Sends the bot invite link for PluralKit.
- `pk;import` - Imports a data file from PluralKit or Tupperbox.
2019-07-15 15:37:34 +00:00
- `pk;export` - Exports a data file containing your system information.
2020-01-25 15:40:03 +00:00
- `pk;permcheck [server id]` - [Checks the given server's permission setup ](/tips#permission-checker-command ) to check if it's compatible with PluralKit.
2019-07-03 09:44:57 +00:00
## API
- `pk;token` - DMs you a token for using the PluralKit API.
- `pk;token refresh` - Refreshes your API token and invalidates the old one.
## 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;commands` - Directs you to this page!
