Docs / Platform / Bot commands
Generated4 commands

Bot commands

Four commands come from YourBot itself rather than from a service. They work in every server the bot is in, whether or not any service is enabled, and cannot be renamed or restricted per server.

/help

How to use YourBot: commands available here plus dashboard and support links

/help

Answers "what can I do with YourBot here?" No options. The reply is always private to you, so it never adds noise to a channel. It works in every server the bot is in and in a DM with the bot.

In a server the reply is an embed titled "YourBot help". With at least one feature enabled, the text says YourBot is set up and managed from the web dashboard, gives the dashboard address, and continues "The commands below come from the features enabled in this server." A "Commands in this server" field lists one line per enabled service that has slash commands, for example "Scheduled Announcements: /announce" or "Group Finder: /group, /group-admin, /group-alerts". When an enabled feature has no commands of its own, such as Social Feeds or a marketplace plugin, the field adds "Some enabled features work from the dashboard or add their own commands to the / picker." A list too long for one field is cut short with "…and more in the dashboard".

With nothing enabled the text reads "No features are enabled in this server yet, so there are no feature commands to show. A server admin can turn them on at" the dashboard address "in about a minute. Try /yourbot for the setup steps."

Every server reply ends with two more fields. "Always available" lists the platform commands: "/yourbot: is YourBot set up in this server?", "/support: get a human, usually within minutes" and "/pluginbugreport: report a bug in an installed plugin to its developer". "Links" holds Dashboard, Documentation and Support server links. Under the embed sits a "Get help in Discord" button that opens the support server invite inside Discord.

In a DM the embed says "YourBot upgrades your Discord server with features you manage from a simple web dashboard. Add it to a server and use /help there to see the commands available." with the same Links field and button.

Good to know

  • The list matches what members can really run. A command switched off for everyone under Command Access is left out, and a service with all of its commands switched off disappears from the list.
  • On a server with its own custom bot, renamed commands appear under their new names. On the shared bot the original names are shown, because renames do not apply there.
  • Built-in services always count. A marketplace plugin the server is not entitled to is left out.
  • If the server's settings cannot be read at that moment, the reply falls back to the plain command list rather than failing.

/pluginbugreport

Report a bug in an installed plugin to its developer.

/pluginbugreport <plugin>
OptionTipoObrigatórioDescrição
plugintextSimThe plugin you're reporting a bug in

Sends a bug report about a marketplace plugin to that plugin's developer. One required option, plugin. As you type, the list suggests the marketplace plugins installed on this server, shown as "Name (plugin id)" and filtered by what you typed. The list is empty in a DM and on a server with no marketplace plugins installed.

What happens when you run it. A form titled "Report a plugin bug" opens with two fields: "Summary", required, up to 200 characters, hinted "One-line description of the bug", and "Details (optional)", up to 4000 characters, hinted "What happened? What did you expect? Steps to reproduce?". You have ten minutes to submit it.

Where the report goes. On submit the report is stored for the developer with your summary, your details, the plugin version installed on this server, and the server name, channel name and your display name for context. The bot confirms privately with the report number and the plugin's name, and says the developer can reply through the developer portal. Nobody else in the channel sees anything.

What the developer receives. The report appears on the Reports tab of their plugin in the developer portal, with an open-report count on the tab. They see the summary, the details, the version, the server and channel, and who reported it. They can set the status to open, in progress, resolved, won't fix or duplicate, and write a reply that you can read.

What you get back. The first time the developer replies, you receive a dashboard notification titled "The developer replied to your bug report for" the plugin's name, linking to the plugin's marketplace page. Its "My reports" section lists each of your reports with its status and the reply.

Limits and errors. You can have at most 10 open reports per plugin. Past that, and when the plugin no longer exists in the marketplace or you typed a name that is not a marketplace plugin, the bot answers with a "Couldn't submit your report" message that names the reason in brackets, for example "Couldn't submit your report (too_many_open_reports). Please try again later." If the platform cannot be reached: "Couldn't reach the platform. Please try again in a minute." Submitting the form from a DM gets "This must be used inside a server."

Good to know

  • It is for marketplace plugins only. For a problem with one of the ten built-in services, use /support.
  • Marketplace plugins run on servers with a custom bot, so on the shared bot the suggestion list is normally empty.
  • YourBot staff can see open reports too, but the developer is the one who answers.

/support

Stuck? Get help from the YourBot team in Discord, usually within minutes

/support

For when you are stuck and want a person. No options. The reply is private to you and works everywhere the bot is: in any server, whether or not a feature is enabled there, and in a DM with the bot.

The reply is an embed titled "Get help with YourBot". Its text: "The fastest way to get unstuck is the support server. A real person usually answers within minutes. Bring your server name and what you were trying to do." Under it, a "Get help in Discord" button opens the invite to the YourBot support server, and the invite opens inside Discord rather than in a browser.

An "Other ways" field points to the alternatives: "/help: the commands available in this server", "/pluginbugreport: send a bug in a marketplace plugin to its developer" and a Documentation link.

What it does not do. It does not open a ticket, collect any details or message anyone on your behalf. It only hands you the door. It reads no server settings, so it keeps working while other features are having trouble.

Good to know

  • It is a platform command, available in every server the bot is in, and it is never paywalled.
  • /help carries the same button, so either command gets you to the support server.

/yourbot

See if YourBot is set up in this server and how to get started

/yourbot

Answers "is YourBot set up in this server?" for any member, and shows how to finish setup when it is not. No options.

The reply is public on purpose, so the whole channel sees the answer. To keep it from being used as spam, only the first use in a channel per 60 seconds is public; further uses inside that minute get the same reply privately. In a DM the reply is always private.

Three server states, one embed each:

  • Features are enabled. Title "YourBot is active in this server", then "Enabled features:" with a bullet list of up to 12 feature names, "• and N more" when there are more, and "Manage them at" with a link to the dashboard's Servers page.
  • The server is connected on the dashboard but nothing is enabled. Title "YourBot is almost ready", text "This server is already connected on the dashboard, but no features are enabled yet. Turn them on at" with the same link.
  • Not set up at all. Title "Get YourBot for this server", text "YourBot is in this server, but none of its features are turned on yet. A server admin can finish setup in about a minute. Everything is managed from the web dashboard. No setup commands needed." Two fields follow. "What you get": analytics, leaderboards and member insights; moderation, automod and raid protection; tickets, giveaways, events and join to create voice channels; a marketplace of plugins to add more. "How to set it up": go to the dashboard, sign in with Discord, pick this server and turn on the features you want.

The service picker. When nothing is enabled and you hold Manage Server or Administrator, the reply also carries a menu, "Pick the services you want", listing the ten built-in services with a one-line description each, plus an "Open the dashboard" link and a "Get help in Discord" button. Pick one or more and the message turns into a confirm screen titled "N services picked for {server}" that says what auto setup creates for each pick, with three buttons. "Set them up for me" enables the services and runs each one's auto setup, the same setup the dashboard wizard runs. "Set up in the dashboard" enables them and links to the Services page. "Change selection" goes back. Progress then shows as "Setting up {server}" and ends with "Setup finished in {server}", or "Setup finished in {server}, with problems" when something failed, one line per service. Every click is checked against Manage Server at click time; anyone else sees "Only someone with Manage Server in that server can do this."

In a DM the embed is "Get YourBot for your server" with the same two fields and no picker.

Good to know

  • Feature names come from the plugin names, for built-in and marketplace plugins alike. Built-in services are always listed; a marketplace plugin the server is not entitled to is not.
  • The picker is the same one the welcome DM carries after the bot joins a server. An old picker answers "That button has expired. Run /yourbot in the server to start again."
  • Only one auto setup runs per server at a time. A second click while one runs gets "Setup is already running for that server."
YourBot docs Reference tables are generated from the code that is running. Ask in Discord Suggest a correction