Skip to main content

Setup CommandKit

info
  • CommandKit requires at least Node.js v24
  • This documentation assumes that you have a basic understanding of how to use discord.js. If you are new to discord.js, we recommend you to read the discord.js guide first.

The quickest way to setup a new CommandKit project is to use the create-commandkit CLI. To get started, run the following command in your terminal:

npm create commandkit@next

This will start the CLI in an interactive mode. You can follow the prompts to setup your project.

Project structure​

By using the CLI to create a base project, you should get a file tree that looks something like this:

.
├── src/
│   ├── app/
│   │   ├── commands/
│   │   │   └── ping.ts
│   │   └── events/
│   │       └── ready/
│   │           └── log.ts
│   └── app.ts
├── .env
├── .gitignore
├── commandkit.config.ts
├── package.json
└── tsconfig.json

Entry point​

The src/app.ts file is the main entry point for your application. This file default exports the discord.js client instance which CommandKit loads at runtime.

src/app.ts
import { Client } from 'discord.js';

const client = new Client({
  intents: ['Guilds', 'GuildMessages', 'MessageContent'],
});

// Optional: Setting up the token manually
client.token = process.env.MY_BOT_TOKEN;

export default client;

Notice how there's no client.login() in this file. This is because CommandKit will automatically handle the login process for you when the application starts.

Development version​

If you would like to try the latest development builds, you can use the @dev tag like so:

npm create commandkit@dev
warning

The development version is likely to have bugs.

Manual setup​

Alternatively, if you would like to setup a new CommandKit project manually, you can follow this guide.