Create Robo
Start new Robo.js projects and plugins.
The create-robo interactive CLI scaffolds new Robo.js projects and plugins. It is a standalone tool that guides you through setup without adding any dependencies to your project.
New Robo
Create a project named "my-awesome-robo":
npx create-robo@next my-awesome-roboYarn Node Linker Configuration
Yarn users will need to configure the nodeLinker by setting the YARN_NODE_LINKER variable to node-modules.
When using Windows you may encounter an npm error like this:
npx : File C:\Program Files\nodejs\npx.ps1 cannot be loaded because running scripts is disabled on this system.If you receive this error, see Windows Execution Policies for a solution.
The CLI walks you through three steps:
- TypeScript or JavaScript
- Select features (ESLint, Prettier, Plugins)
- Enter your Discord token and client ID (or press Enter to skip and edit
.envlater)
New Plugin
To create a plugin project, run the CLI with the --plugin flag:
npx create-robo@next my-awesome-plugin --pluginThis guides you through two steps:
- TypeScript or JavaScript
- Select features (ESLint, Prettier)
Options
| Flag | Description |
|---|---|
-f, --features <features> | Comma-separated list of features to include |
--js, --javascript | Create a Robo using JavaScript |
-k, --kit | Choose a kit to start with |
-ni, --no-install | Skip dependency installation |
-nu, --no-update | Skip the update check |
-P, --plugin | Create a plugin project instead of a Robo |
-p, --plugins <plugins> | Install plugins from the start (e.g., @robojs/ai) |
-rv, --robo-version <version> | Specify a Robo.js version to use |
-t, --template <template> | Create a Robo from an online template |
--ts, --typescript | Create a Robo using TypeScript |
-v, --verbose | Print more information for debugging |
Kits
Kits are pre-defined feature and template combinations for common project types:
activity- Create a Discord Activitybot- Create a Discord Botweb- Create a Webapp
