General Commands

General commands for plugin information, configuration management, and debugging.

Command Summary

CommandDescription
/hp help [command]Show help information
/hp infoShow plugin information
/hp reloadReload configuration and data
/hp syncSynchronize data across servers
/hp verbose [on|off]Toggle verbose permission checking
/hp check [player] <permission>Check if a permission is granted

Permissions

PermissionDescriptionDefault
hyperperms.command.helpAccess to /hp helptrue
hyperperms.command.infoAccess to /hp infoop
hyperperms.command.reloadAccess to /hp reloadop
hyperperms.command.syncAccess to /hp syncop
hyperperms.command.verboseAccess to /hp verboseop
hyperperms.command.checkAccess to /hp checkop

Command Details

/hp help

Display help information for HyperPerms commands.

text
Usage: /hp help [command]

Examples:
/hp help              # Show general help
/hp help group        # Show help for group commands
/hp help user info    # Show help for specific command

/hp info

Display information about the HyperPerms installation.

text
Usage: /hp info

Output:
[HyperPerms] HyperPerms v1.0.0
[HyperPerms] Storage: JSON
[HyperPerms] Groups loaded: 5
[HyperPerms] Users loaded: 127
[HyperPerms] Tracks loaded: 2
[HyperPerms] Context calculators: world, gamemode

This command shows:

  • Plugin version
  • Storage backend type
  • Number of loaded groups, users, and tracks
  • Active context calculators

/hp reload

Reload configuration and permission data from disk.

text
Usage: /hp reload

Output:
[HyperPerms] Reloading configuration...
[HyperPerms] Configuration reloaded successfully.
[HyperPerms] Loaded 5 groups, 127 users, 2 tracks.
Use reload after manually editing configuration files. Changes made through commands are saved automatically.
Some configuration changes require a full server restart, such as changing the storage backend type.

/hp sync

Force synchronization of permission data. Useful in multi-server setups or after manual database modifications.

text
Usage: /hp sync

Output:
[HyperPerms] Synchronizing permission data...
[HyperPerms] Sync complete. Updated 3 users.

This command:

  • Saves any pending changes to storage
  • Reloads data from storage
  • Updates cached permission calculations
  • Notifies other connected servers (if networked)

/hp verbose

Toggle verbose mode to see detailed permission check information. This is extremely useful for debugging permission issues.

text
Usage: /hp verbose [on|off|filter]

Examples:
/hp verbose           # Toggle verbose mode
/hp verbose on        # Enable verbose mode
/hp verbose off       # Disable verbose mode
/hp verbose Steve     # Only show checks for Steve

When enabled, you'll see output like:

text
[Verbose] Steve checked: fly.enable
[Verbose]   Context: world=hub, gamemode=survival
[Verbose]   Checking user permissions... not found
[Verbose]   Checking group 'admin'... not found
[Verbose]   Checking group 'mod' (inherited)... not found
[Verbose]   Checking group 'vip' (inherited)... FOUND: true [world=hub]
[Verbose]   Result: true
Verbose mode only shows permission checks to the player who enabled it. Other players won't see the verbose output.
Verbose mode can generate a lot of output. Use filters or disable it when not actively debugging.

/hp check

Check whether a player has a specific permission. Useful for testing permission configuration.

text
Usage: /hp check [player] <permission>

Examples:
/hp check Steve fly.enable        # Check if Steve has fly.enable
/hp check fly.enable              # Check if you have fly.enable
/hp check Steve hyperperms.admin  # Check admin permission

Output shows:

  • Whether the permission is granted or denied
  • Which group or user setting provides the permission
  • Any relevant context requirements
text
/hp check Steve fly.enable

[HyperPerms] Permission check for Steve:
[HyperPerms]   fly.enable: true
[HyperPerms]   Source: group 'vip' [world=hub]
[HyperPerms]   Current context: world=hub (matches)

Backup Commands

HyperPerms includes built-in backup functionality:

CommandDescription
/hp backup create [name]Create a manual backup
/hp backup listList available backups
/hp backup restore <name>Restore from a backup

/hp backup create

text
Usage: /hp backup create [name]

Examples:
/hp backup create                    # Create with timestamp name
/hp backup create before-reset       # Create with custom name

Output:
[HyperPerms] Backup created: backup-2024-01-15-143022.json

/hp backup list

text
Usage: /hp backup list

Output:
[HyperPerms] Available backups:
[HyperPerms]   1. backup-2024-01-15-143022.json (2.3 MB)
[HyperPerms]   2. backup-2024-01-14-120000.json (2.1 MB)
[HyperPerms]   3. before-reset.json (2.0 MB)

/hp backup restore

text
Usage: /hp backup restore <name>

Example:
/hp backup restore before-reset

Output:
[HyperPerms] Restoring from backup: before-reset.json
[HyperPerms] Backup restored successfully.
[HyperPerms] Loaded 5 groups, 120 users, 2 tracks.
Restoring a backup will overwrite all current permission data. Create a backup of the current state before restoring if you might need it.

See Also