Commands Overview¶
Spruce Bot offers over 90 commands across multiple categories. This section provides comprehensive documentation for all available commands.
Command Categories¶
-
Automatic role assignment for new members
- Add/remove auto roles
- Configure for humans and bots
- List and reset configurations
-
Server management and moderation tools
- Channel locking/unlocking
- Message management
- Member kick/ban
- Permission controls
-
Advanced role assignment and management
- Bulk role operations
- Role creation/deletion
- Member role management
-
General purpose tools and information
- User/server information
- Embed creation
- Translation and TTS
-
Complete esports tournament management
- Tournament setup
- Registration management
- Group creation
-
Practice match organization
- Scrim configuration
- Time-based registration
- Slot management
-
Bot administration and debugging
- System information
- Database management
- Debug tools
Quick Reference¶
Essential Commands¶
| Command | Description | Permission Required |
|---|---|---|
&help | Show interactive help menu | None |
&ping | Check bot latency | None |
&sync | Sync slash commands | Administrator |
&botinfo | Bot statistics | None |
&serverinfo | Server information | None |
Most Used Commands¶
| Command | Category | Description |
|---|---|---|
&autorole add human @role | AutoRole | Add auto role for humans |
&lock | Moderation | Lock current channel |
&clear 10 | Moderation | Delete 10 messages |
&role @role @user | Roles | Give role to user |
/tourney setup | Tournaments | Create tournament |
Command Syntax¶
All commands follow these syntax conventions:
Prefix Commands¶
Slash Commands¶
Parameter Types¶
| Type | Description | Example |
|---|---|---|
@user | User mention | @john#1234 |
@role | Role mention | @Members |
#channel | Channel mention | #general |
<text> | Text input | "Hello World" |
<number> | Numeric input | 10, 100 |
<true\|false> | Boolean choice | true, false |
Permission Levels¶
Commands are organized by required permission levels:
Commands that anyone can use:
&help,&ping,&userinfo&avatar,&serverinfo,&botinfo&translate,&toss
Basic moderation commands:
&clear,&embed&tts
Role and permission management:
&autorole,&role,&lock&hide,&give_role
Channel management:
&channel_make,&channel_del&create_channel,/tourney setup
Member moderation:
&kick
Advanced moderation:
&ban,&unban
Full server management:
&sync,&delete_category&remove_members
Command Features¶
Interactive Elements¶
Many commands include interactive elements:
- Buttons: Confirm actions, reverse operations
- Dropdowns: Select from multiple options
- Modals: Input detailed information
- Reactions: Navigate through pages
Bulk Operations¶
Several commands support bulk operations:
&create_roles name1 name2 name3&del_roles @role1 @role2 @role3&give_role @role @user1 @user2 @user3&channel_make channel1 channel2 channel3
Safety Features¶
Important commands include safety measures:
- Confirmation dialogs for destructive actions
- Role hierarchy checks to prevent privilege escalation
- Rate limiting to prevent spam
- Undo buttons for reversible operations
Command Status¶
| Status | Description | Example |
|---|---|---|
| Active | Fully functional | Most commands |
| Maintenance | Temporarily disabled | Music commands |
| Beta | Testing phase | New features |
| Deprecated | Being phased out | Old command aliases |
Error Handling¶
When commands fail, Spruce Bot provides clear error messages:
Common Error Types¶
Getting Help¶
Built-in Help System¶
Use the interactive help system for detailed information:
&help # Show main help menu
&help <command> # Get specific command help
&help <category> # Show category commands
Command Documentation¶
Each command page includes:
- Description - What the command does
- Usage - Syntax and parameters
- Examples - Real-world usage scenarios
- Permissions - Required user and bot permissions
- Troubleshooting - Common issues and solutions
External Resources¶
- Support Server - Live community help
- GitHub Issues - Bug reports
- Feature Requests - Suggest improvements
Next Steps: - Explore specific command categories - Check the troubleshooting guide for common issues - Join our support community for help