Commands Overview
HyperPerms provides a comprehensive set of commands for managing permissions, groups, users, and tracks. All commands start with /hp.
Base Command
The base command for HyperPerms is /hp. You can also use these aliases:
/hyperperms- Full command name/perms- Short alias/perm- Shortest alias
/hp help in-game for a quick command overview.Command Categories
General Commands
Help, check, reload, export, debug, backup, and more
Group Commands
Create, modify, and delete permission groups
User Commands
Manage individual player permissions and groups
Track Commands
Manage promotion and demotion tracks
Editor Commands
Web editor integration commands
Template Commands
Create and apply permission templates
Analytics Commands
Permission analytics and audit logging
Command Syntax
Commands use the following syntax conventions:
<required>- Required argument (must be provided)[optional]- Optional argument (can be omitted)value|other- Choose one of the listed options[duration]- Optional duration (e.g.1d12h,30m)[contexts...]- Optional context key=value pairs
Permission Requirements
Commands require specific permissions to use. Here's a summary of the base permissions:
| Permission | Description | Default |
|---|---|---|
hyperperms.admin | Access to all HyperPerms commands | op |
hyperperms.command.help | Access to help command | true |
hyperperms.command.check | Access to check command | op |
hyperperms.command.reload | Access to reload command | op |
hyperperms.command.export | Access to export command | op |
hyperperms.command.update | Access to update commands | op |
hyperperms.command.user | Access to user management commands | op |
hyperperms.command.group | Access to group management commands | op |
hyperperms.command.track | Access to track management commands | op |
hyperperms.command.editor | Access to web editor commands | op |
hyperperms.command.debug | Access to debug commands | op |
hyperperms.command.backup | Access to backup commands | op |
hyperperms.command.perms | Access to permission discovery | op |
hyperperms.command.import | Access to import commands | op |
hyperperms.command.template | Access to template commands | op |
hyperperms.command.analytics | Access to analytics commands | op |
hyperperms.command.migrate | Access to migration commands | op |
hyperperms.admin permission grants access to all HyperPerms commands. Use more specific permissions for finer control.Quick Reference
Essential Commands
| Command | Description |
|---|---|
/hp help | Show help information |
/hp check <player> <permission> | Check if a player has a permission |
/hp reload | Reload configuration and data |
/hp editor | Open the web editor |
Group Management
| Command | Description |
|---|---|
/hp group list | List all groups |
/hp group create <name> | Create a new group |
/hp group info <group> | View group details |
/hp group setperm <group> <perm> [value] [duration] | Set permission on group |
/hp group unsetperm <group> <perm> | Remove permission from group |
User Management
| Command | Description |
|---|---|
/hp user info <player> | View user details |
/hp user addgroup <player> <group> [duration] | Add user to group |
/hp user setperm <player> <perm> [value] [duration] | Set permission on user |
/hp user unsetperm <player> <perm> | Remove permission from user |
/hp user promote <player> <track> | Promote user on track |
Track Management
| Command | Description |
|---|---|
/hp track list | List all tracks |
/hp track create <name> | Create a new track |
/hp track append <track> <group> | Add group to track |
Debug Commands
| Command | Description |
|---|---|
/hp debug perms | Toggle verbose permission checking |
/hp debug tree <user> | Show permission inheritance tree |
/hp debug resolve <user> <permission> | Trace permission resolution |
/hp debug contexts <user> | Show active contexts for user |
/hp debug toggle <category|all> [on|off] | Toggle debug categories |
/hp debug status | Show current debug status |
Backup Commands
| Command | Description |
|---|---|
/hp backup create [--name=prefix] | Create a backup |
/hp backup list | List available backups |
/hp backup restore <backup> | Restore from a backup |
Permission Discovery
| Command | Description |
|---|---|
/hp perms list [category] | List registered permissions |
/hp perms search <query> | Search permissions by pattern |
Import Commands
| Command | Description |
|---|---|
/hp import defaults | Import default permission setup |
/hp import file <filename> | Import from a JSON file |
Template Commands
| Command | Description |
|---|---|
/hp template list | List available templates |
/hp template apply <name> | Apply a template |
/hp template create <name> | Create a template from current setup |
/hp template delete <name> | Delete a template |
Analytics Commands
| Command | Description |
|---|---|
/hp analytics status | Show analytics status |
/hp analytics report [period] | Generate analytics report |
/hp analytics audit <player> | View audit log for a player |
Migration Commands
| Command | Description |
|---|---|
/hp migrate luckperms | Preview LuckPerms migration |
/hp migrate luckperms-confirm | Execute LuckPerms migration |
Tab Completion
HyperPerms supports tab completion for all commands. Press Tab while typing to:
- Complete command names
- Show available subcommands
- Complete group and track names
- Suggest online player names
- Suggest common permission nodes
Detailed Documentation
For complete documentation of each command category, visit the individual pages:
- General Commands - Core utility, debug, backup, import, and export commands
- Group Commands - Full group management
- User Commands - Full user management
- Track Commands - Track management
- Editor Commands - Web editor integration
- Template Commands - Permission templates
- Analytics Commands - Analytics and audit
Have a question about commands or found an issue?
Send us feedback β