Skip to main content

Getting Started

Dive into the world of Robo.js, where developing Discord bots is more fun, easier, and seamlessly integrates with plugins. 🎉

Quickstart 🚀​

The easiest way to get started with Robo.js is to use the interactive CLI. Run the following command in your terminal:

npx create-robo <projectName>

This command guides you through setting up a project tailored to your preferences, including TypeScript, linting, styling, and plugins.

Note: Don't forget to replace <projectName> with the desired name for your new Robo.

Upgrading Existing Project ⏫​

Depending on your bot's complexity, there are 3 smooth migration paths to choose from. Each tailored to make your bot's transition as seamless as possible.

Check out our migration guide for a detailed breakdown of the 3 migration options, and pick the one that suits your bot best. Get ready to level up your bot development experience!

➞ 📚 See the full migration guide

Robo.js CLI Commands & Benefits ⌨️​

Boost your bot development with Robo.js' nifty CLI commands. Use robo dev to run your project, automatically watch for changes, and restart. Plus, Robo.js takes care of those tricky lifecycle events to dodge common bot bugs. When you're set to deploy, just hit robo build to compile and robo start to launch production mode.

npm run dev

Wanna know more? Check out the Command Line Interface documentation.

With Robo.js, there's no need for a separate script to register command updates. Sit back and relax—Robo.js has got you covered!

Troubleshooting 🛠️​

If you run into issues, execute robo doctor to automatically detect common problems and offer fixes. This command can also identify issues with Robo.js plugins. Check out the Debugging Docs and feel free to ask Sage for help.

Note: You can summon Sage in the documentation site at any time by pressing Command + K or Control + K.

Next Steps 🧭​

Now that you're all set up, explore these sections to level up your Robo.js skills:

  1. Developing your Robo - Learn how to develop your Robo, create commands and events, and interact with the Discord API.
  2. Adding to Discord server - Discover how to add your Robo to a Discord server and set up permissions.
  3. Creating Plugins - Discover how to create plugins that extend the functionality of Robo.js and share them with the community.
  4. Hosting your Robo - Get your Robo up and running on a hosting service to ensure it's always online and ready to serve your Discord server.