DevBuddy Documentation
Dive deep into DevBuddy's features, commands, and capabilities. Everything you need to master your AI coding companion on Discord.
🚀 Getting Started with DevBuddy
Welcome to the DevBuddy documentation! This guide will walk you through the process of adding DevBuddy to your Discord server and understanding its core functionalities. Get ready to supercharge your coding ` discussions!
Installation & Setup
Adding DevBuddy to your server is quick and easy. Follow these steps to begin:
- Click the "Add DevBuddy to Discord" button on our homepage or in the documentation hero above.
- You will be redirected to Discord's authorization page. Select the server you wish to add DevBuddy to. (You must have "Manage Server" permissions).
- Review the requested permissions (detailed below) and click "Authorize".
- Once authorized, DevBuddy will join your server, and you'll receive a welcome message in your default channel.
Tip: After inviting DevBuddy, we recommend creating a dedicated #coding-help or #devbuddy-bot
channel to keep your server organized!
Required Permissions
For DevBuddy to function optimally, it requires the following permissions. These are carefully selected to ensure full functionality without unnecessary access:
- Read Messages / View Channels: To see and respond to commands.
- Send Messages: To send command responses, challenge prompts, and explanations.
- Embed Links: To send rich, interactive messages with code blocks and formatted output.
- Use External Emojis: For better visual communication (e.g., success/error reactions).
- Manage Messages (Optional, but Recommended): For cleaning up old bot messages or command invocations (e.g., for `clear` functionality).
If DevBuddy isn't responding, check if it has these necessary permissions in your server settings.
✨ Commands Reference
DevBuddy offers a wide array of commands to assist you in your coding journey. All commands are
prefixed
with / or d! (slash
commands) for a seamless Discord experience.
🧠 AI & Utility Commands
Leverage DevBuddy's AI for instant explanations, suggestions, and quick coding tasks.
/explain
Get an AI-powered explanation for any code snippet or concept.
/explain code:"print('Hello')" language:python
# Default language is auto-detected if not specified
Parameters:
- code: (Required) The code snippet or concept you want explained.
- language: (Optional) Specify the programming language (e.g., `javascript`, `python`, `java`).
/debug
Receive AI assistance in debugging your code and identifying errors.
/debug code:"def func(x): return x / 0" language:python
Parameters:
- code: (Required) The buggy code snippet.
- language: (Optional) The programming language.
/refactor
Get AI suggestions to refactor and improve the quality of your code.
/refactor code:"if x > 10: return True else: return False"
Parameters:
- code: (Required) The code snippet to refactor.
- style: (Optional) Specify a refactoring style (e.g., `concise`, `readable`).
🏆 Challenge Commands
Test your coding prowess with interactive challenges and track your progress.
/challenge start
Initiate a new coding challenge based on your preferred difficulty.
/challenge start difficulty:easy language:javascript
Parameters:
- difficulty: (Required) Choose `easy`, `medium`, or `hard`.
- language: (Optional) Preferred language for the challenge.
/challenge submit
Submit your solution for the current coding challenge to be evaluated by AI.
/challenge submit solution:```js\nfunction sum(a,b){return a+b}\n```
Parameters:
- solution: (Required) Your code wrapped in a Discord code block (e.g., ````js\n//code\n````).
💡 Advanced Usage & Tips
DevBuddy is powerful, and with these advanced tips, you can make the most out of your AI coding assistant.
Best Practices for AI Interaction
- Be Specific: When asking for explanations or debugging, provide as much context as possible. Specify the language, desired output, or expected behavior.
- Use Code Blocks: Always wrap your code snippets in Discord's code blocks (e.g., ````python\nprint("hello")\n````) to ensure correct formatting and interpretation by DevBuddy.
- Iterate: If the first AI response isn't perfect, try rephrasing your query or providing additional details. AI learns from clear inputs!
- Combine Commands: Use
/explainto understand a problem, then/debugor/refactorto refine your solution.
Troubleshooting Common Issues
Encountering an issue? Here are some common problems and their solutions:
- DevBuddy isn't responding:
- Check if DevBuddy has "Send Messages" and "Read Message History" permissions in the channel.
- Ensure DevBuddy's role is above any channel-specific permission overrides that might block it.
- Confirm DevBuddy is online in your server's member list.
- "I don't understand that command":
- Double-check your spelling. All commands start with
/or some with:d! - Ensure you're using the correct parameters and syntax as described in the commands reference.
- Double-check your spelling. All commands start with
- AI responses are unhelpful:
- Try to be more specific with your prompt. Provide example inputs, desired outputs, or a more detailed problem description.
- Ensure your code is properly formatted in a code block.
If you're still experiencing problems, please visit our support server (link in footer) for assistance!