Command-Usage.md

Command usage is printed to the console/chat whenever invalid arguments are provided. Simply typing /lp will list all commands a user has permission to use.

If the only thing returned when you type a command is the plugin version, you do not have permission to use any of the commands. You need to use the server console to give yourself access to LuckPerms commands first.

Aliases

A list of aliases for each platform are listed below. Each command works in exactly the same manner, so you can use whichever you prefer.

Bukkit / Sponge / Nukkit	BungeeCord	Velocity
/luckperms	/luckpermsbungee	/luckpermsvelocity
/perms	/bperms	/vperms
/permissions	/bpermissions	/vpermissions
/perm	/bperm	/vperm
/lp	/lpb	/lpv

Important: The command aliases are different on BungeeCord and Velocity. This is so you can choose where your command gets directed to. If commands were the same, you would never be able to control LuckPerms on a backend server.

If you are using Bukkit/Spigot, by default, all users with OP have access to LuckPerms commands. You can change this in the config.

Overview

Arguments Key:

• <required> - you must specify this argument when running the command
• [optional] - you do not need to specify this argument. a default will be used if not given.

If you want to include spaces in arguments, you must escape the argument with quotes. " "

The alias used below (/lp) can be exchanged for any of the ones listed in the aliases section above.

General commands

General commands used to operate LuckPerms functions.

• /lp
• /lp sync
• /lp info
• /lp editor
• /lp debug
• /lp verbose <on | record | off | upload> [filter]
• /lp tree [scope] [player]
• /lp search <permission>
• /lp check <user> <permission>
• /lp networksync
• /lp import <file>
• /lp export <file>
• /lp reloadconfig
• /lp bulkupdate
• /lp migration
• /lp creategroup <group>
• /lp deletegroup <group>
• /lp listgroups
• /lp createtrack <track>
• /lp deletetrack <track>
• /lp listtracks

User commands

Commands used to view or modify a specific user.

Formed of /lp user <user> ... - where <user> is the username or uuid of the user being queried / modified.

• /lp user <user> info
• /lp user <user> permission
• /lp user <user> parent
• /lp user <user> meta
• /lp user <user> editor
• /lp user <user> promote <track> [context...]
• /lp user <user> demote <track> [context...]
• /lp user <user> showtracks
• /lp user <user> clear [context...]
• /lp user <user> clone <user>

Group commands

Commands used to view or modify a specific group.

Formed of /lp group <group> ... - where <group> is the name of the group being queried / modified.

• /lp group <group> info
• /lp group <group> permission
• /lp group <group> parent
• /lp group <group> meta
• /lp group <group> editor
• /lp group <group> listmembers [page]
• /lp group <group> setweight <weight>
• /lp group <group> setdisplayname <name>
• /lp group <group> showtracks
• /lp group <group> clear [context...]
• /lp group <group> rename <new name>
• /lp group <group> clone <name of clone>

Permission commands

Commands used to view or modify the permissions data of a specific user or group.

Formed of either /lp user <user> permission ... or /lp group <group> permission ...

• info
• set <node> <true/false> [context...]
• unset <node> [context...]
• settemp <node> <true/false> <duration> [temporary modifier] [context...]
• unsettemp <node> [context...]
• check <node> [context...]
• checkinherits <node> [context...]
• clear [context...]

Parent commands

Commands used to view or modify the inheritance properties (parents) of a specific user or group.

Formed of either /lp user <user> parent ... or /lp group <group> parent ...

• info
• set <group> [context...]
• add <group> [context...]
• remove <group> [context...]
• settrack <track> <group> [context...]
• addtemp <group> <duration> [temporary modifier] [context...]
• removetemp <group> [context...]
• clear [context...]
• cleartrack <track> [context...]
• switchprimarygroup <group>

Meta commands

Commands used to view or modify the metadata of a specific user or group.

Formed of either /lp user <user> meta ... or /lp group <group> meta ...

• info
• set <key> <value> [context...]
• unset <key> [context...]
• settemp <key> <value> <duration> [temporary modifier] [context...]
• unsettemp <key> [context...]
• addprefix <priority> <prefix> [context...]
• addsuffix <priority> <suffix> [context...]
• setprefix [priority] <prefix> [context...]
• setsuffix [priority] <suffix> [context...]
• removeprefix <priority> [prefix] [context...]
• removesuffix <priority> [suffix] [context...]
• addtempprefix <priority> <prefix> <duration> [temporary modifier] [context...]
• addtempsuffix <priority> <suffix> <duration> [temporary modifier] [context...]
• settempprefix [priority] <prefix> <duration> [temporary modifier] [context...]
• settempsuffix [priority] <suffix> <duration> [temporary modifier] [context...]
• removetempprefix <priority> [prefix] [context...]
• removetempsuffix <priority> [suffix] [context...]
• clear [context...]

Track commands

Commands used to view or modify a specific track.

Formed of /lp track <track> ... - where <track> is the name of the track being queried / modified.

• /lp track <track> info
• /lp track <track> append <group>
• /lp track <track> insert <group> <position>
• /lp track <track> remove <group>
• /lp track <track> clear
• /lp track <track> rename <new name>
• /lp track <track> clone <name of clone>

Log commands

Commands used to view the action log.

• /lp log recent [user] [page]
• /lp log search <query> [page]
• /lp log notify [on|off]
• /lp log export <file>
• /lp log userhistory <user> [page]
• /lp log grouphistory <group> [page]
• /lp log trackhistory <track> [page]