3.2 KiB
Command list
This page shows a list of all commands PluralKit supports.
How to read this page
The first block for each command, Usage, shows the format of each command. This is essentially a "template" you'll need to fill in. The parts you can change are called arguments, and they're highlighted.
Arguments
The command's Arguments section will describe how to fill them in, and what you need to put there.
::: details Example of a command with an argument Here's an example of a command with an argument: some-command this-is-an-argument
When running this command, fill in the argument like so: some-command My cool text :::
Systems and members
Some commands accept a target system or member:
For systems, this can either be a 5-character ID, a @mention, or a Discord user ID.
In many cases you can leave the system out entirely. Instead, it'll just use your own system.
::: details Example of referring to systems system list system abcde list system @Myriad#1234 list system 466378653216014359 list :::
For members, this can be the member's name or their 5-character ID.
::: details Example of referring to members member Myriad info member "Myriad Kit" member zxcvb info :::
::: warning If you're trying to refer to a member with spaces or emojis in their name, you'll need to wrap the name in either 'single' or "double" quotes. Alternatively, you can use the member ID. :::
Flags
Flags are small options you can apply to a command to change its behavior.
All flags follow the format -word or -multiple-words (as in, they all start with a -).
Flags may appear in any order, and most flags can appear anywhere in the command
(with some exceptions; although placing them before the first argument is usually a safe bet).
A common flag is -clear, which is used for most "change" commands. This flag instructs the command to clear a value instead of showing or changing it. For example, to clear your system description, you'd use the flag like this:
system description -clear
Commands with flags list the flags in the Flags section below, along with an explanation of what they do.
System commands
::: tip You can use s instead of system as a short-hand. :::
Member commands
::: tip You can use m instead of member as a short-hand. :::
Switch commands
::: tip You can use sw instead of switch as a short-hand. :::