LogoRobo.js

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-robo

Yarn 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:

  1. TypeScript or JavaScript
  2. Select features (ESLint, Prettier, Plugins)
  3. Enter your Discord token and client ID (or press Enter to skip and edit .env later)

New Plugin

To create a plugin project, run the CLI with the --plugin flag:

npx create-robo@next my-awesome-plugin --plugin

This guides you through two steps:

  1. TypeScript or JavaScript
  2. Select features (ESLint, Prettier)

Options

FlagDescription
-f, --features <features>Comma-separated list of features to include
--js, --javascriptCreate a Robo using JavaScript
-k, --kitChoose a kit to start with
-ni, --no-installSkip dependency installation
-nu, --no-updateSkip the update check
-P, --pluginCreate 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, --typescriptCreate a Robo using TypeScript
-v, --verbosePrint more information for debugging

Kits

Kits are pre-defined feature and template combinations for common project types:

  • activity - Create a Discord Activity
  • bot - Create a Discord Bot
  • web - Create a Webapp

Next Steps

On this page