SupportMail Documentation
Get support
Live Version
Live Version
  • Home
  • Getting Started
  • ❗Migration notes for V2
  • ⭐SupportMail Gold
  • Features
    • Tickets
      • Setup
      • Configuration
      • Anonymous Tickets
      • Close Requests
      • Custom Messages
      • Ticket Panel
      • Reopen Tickets
      • User Feedback
    • Reports
      • Setup
      • Configuration
    • Blacklists
    • View configurations
    • Pausing Features
    • Debugging
    • Tags
    • Preferences
  • Explanations
    • Command Permissions
    • Command Structuring
    • Get IDs
    • Image Links
    • Formats
    • Time-Strings
    • Malicious Files
  • Changelog
    • V2 | November 2024
    • October 2023
  • Other
    • Translate!
    • 📜Website
    • ℹ️Support-Server
Powered by GitBook
On this page

Was this helpful?

  1. Explanations

Command Structuring

Base commands, Subcommands, Subcommand groups - what?

A base command is for example /help. It does not have any subcommands or groups.

/config on the other side has both - subcommands and subcommand groups.

Subcommands organize commands by specifying actions within a command or group.

Subcommand Groups organize subcommands by grouping subcommands by similar action or resource within a command.

Groups cannot be executed, they are just like folders within a file-like system.

Visual examples:

/command
|
|__ subcommand
|
|__ subcommand


/command
|
|__ subcommand-group
    |
    |__ subcommand
|
|__ subcommand-group
    |
    |__ subcommand


/command
|
|__ subcommand-group
    |
    |__ subcommand
|
|__ subcommand

Real-world Examples

/help             - just one base command


/blacklist        - base command
|
|__ add               - subcommand
|
|__ remove            - subcommand


/setup        - base command
|
|__ tickets      - subcommand group
    |
    |__ guided      - subcommand
    |
    |__ quick       - subcommand
|
|__ reports      - subcommand group
    |
    |__ guided      - subcommand
    |
    |__ quick       - subcommand
command
|
|__ subcommand-group
    |
    |__ subcommand-group - a group cannot have a group
|
|__ subcommand-group
    |
    |__ subcommand-group


command
|
|__ subcommand
    |
    |__ subcommand-group - just no


command
|
|__ subcommand
    |
    |__ subcommand - a subcommand cannot have a group or another subcommand.

PreviousCommand PermissionsNextGet IDs

Last updated 6 months ago

Was this helpful?

If you want to go more in-depth, take a look at the .

Developer Docs