From c50a9ea0088bc28aa0a64268f3fc95668cfdb79e Mon Sep 17 00:00:00 2001 From: dev-kittens Date: Sun, 4 Oct 2020 06:38:04 +0000 Subject: [PATCH 01/14] Add member list flags --- docs/content/tips-and-tricks.md | 38 ++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/content/tips-and-tricks.md b/docs/content/tips-and-tricks.md index 03dcfd15..ac3adb9a 100644 --- a/docs/content/tips-and-tricks.md +++ b/docs/content/tips-and-tricks.md @@ -24,4 +24,40 @@ PluralKit has a couple of useful command shorthands to reduce the typing: |pk;member new|pk;m n| |pk;switch|pk;sw| |pk;message|pk;msg| -|pk;autoproxy|pk;ap| \ No newline at end of file +|pk;autoproxy|pk;ap| + +## Member list flags +There are a number of option flags that can be added to the `pk;system list` command. + +### Sorting options +|Flag|Aliases|Description| +|---|---|---| +|-by-name|-bn|Sort by member name (default)| +|-by-display-name|-bdn|Sort by display name| +|-by-id|-bid|Sort by member ID| +|-by-message-count|-bmc|Sort by message count (members with the most messages will appear near the top)| +|-by-created|-bc|Sort by creation date (members least recently created will appear near the top)| +|-by-last-fronted|-by-last-front, -by-last-switch, -blf, -bls|Sort by most recently fronted| +|-by-last-message|-blm, -blp|Sort by last message time (members who most recently sent a proxied message will appear near the top)| +|-by-birthday|-by-birthdate, -bbd|Sort by birthday (members whose birthday is in January will appear near the top)| +|-reverse|-rev, -r|Reverse previously chosen sorting order| +|-random||Sort randomly| + +### Filter options +|Flag|Aliases|Description| +|---|---|---| +|-all|-a|Show all members, including private members| +|-public-only|-public, -pub|Only show public members (default)| +|-private-only|-private, -priv|Only show private members| + +::: warning +You cannot look up private members of another system. +::: + +### Additional fields to include in the search results +|Flag|Aliases|Description| +|---|---|---| +|-with-last-switch|-with-last-fronted, -with-last-front, -wls, -wlf|Show each member's last switch date| +|-with-last-message|-with-last-proxy, -wlm, -wlp|Show each member's last message date| +|-with-message-count|-wmc|Show each member's message count| +|-with-created|-wc|Show each member's creation date| \ No newline at end of file From 2a041d9eb5cf08a5e47776f69179c469bf054ee1 Mon Sep 17 00:00:00 2001 From: dev-kittens Date: Sun, 4 Oct 2020 07:12:40 +0000 Subject: [PATCH 02/14] Document group commands --- docs/content/command-list.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/content/command-list.md b/docs/content/command-list.md index d6cc2828..f07e2b0f 100644 --- a/docs/content/command-list.md +++ b/docs/content/command-list.md @@ -56,6 +56,21 @@ Words in **\** or **[square brackets]** mean fill-in-the-blank. - `pk;member delete` - Deletes a member. - `pk;random` - Shows the member card of a randomly selected member in your system. +## Group commands +*Replace `` with a group's name or 5-character ID. For most commands, adding `-clear` will clear/delete the field.* +- `pk;group ` - Shows information about a group. +- `pk;group new ` - Creates a new group. +- `pk;group list` - Lists all groups in your system. +- `pk;group list` - Lists all members in a group. +- `pk;group rename ` - Renames a group. +- `pk;group displayname [display name]` - Shows or changes a group's display name. +- `pk;group description [description]` - Shows or changes a group's description. +- `pk;group add [member 2] [member 3...]` - Adds one or more members to a group. +- `pk;group remove [member 2] [member 3...]` - Removes one or more members from a group. +- `pk;group privacy ` - Changes a group's privacy settings. +- `pk;group icon [icon]` - Shows or changes a group's icon. +- `pk;group delete` - Deletes a group. + ## Switching commands - `pk;switch [member...]` - Registers a switch with the given members. - `pk;switch move