commandkit

CommandKit

CommandKit is a library that makes it easy to handle commands and events in your Discord.js projects.

Supports Discord.js version 14

Features

• Beginner friendly 🚀
• Slash + context menu commands support ✅
• Multiple dev guilds, users, & roles support 🤝
• Automatic command updates 🤖
• REST registration behaviour 📍
• And much more! 🧪

Documentation

You can find the full documentation here.

Installation

To install CommandKit, simply run the following command:

For npm:

npm install commandkit

Yarn:

yarn add commandkit

pnpm:

pnpm add commandkit

Install development version

To install the development version of CommandKit, run the following command:

npm install commandkit@dev

⚠️ The development version is likely to have bugs.

Usage

This is a simple overview of how to set up this library with all the options. You can read more in the full documentation

// index.js
const { Client, GatewayIntentBits } = require('discord.js');
const { CommandKit } = require('commandkit');
const path = require('path');

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

new CommandKit({
    // Your discord.js client object
    client,

    // Path to the commands folder
    commandsPath: path.join(__dirname, 'commands'),

    // Path to the events folder
    eventsPath: path.join(__dirname, 'events'),

    // Path to the validations folder (only valid if "commandsPath" was provided)
    validationsPath: path.join(__dirname, 'validations'),

    // Array of development server IDs (used to register and run devOnly commands)
    devGuildIds: ['1234567890', '0987654321'],

    // Array of developer user IDs (used for devOnly commands)
    devUserIds: ['1234567890', '0987654321'],

    // Array of developer role IDs (used for devOnly commands)
    devRoleIds: ['1234567890', '0987654321'],

    // Disable CommandKit's built-in validations
    skipBuiltInValidations: true,

    // Update command registration/reload behaviour to register all commands at once
    bulkRegister: true,
});

client.login('YOUR_TOKEN_HERE');

Support and Suggestions

Submit any queries or suggestions in our Discord community.

Changelog

[0.1.9] - 2023-12-12

Changes (breaking)

• Update ValidationFunctionProps type name to ValidationProps.
• Update autocompleteRun command function name to autocomplete.
• Update AutocompleteCommandProps type name to AutocompleteProps.

Deprecated

• guildOnly in command options. CommandKit no longer handles the guildOnly condition. Use dm_permission in your command data object instead.

Fixed

• Broken docs links.

Added

• ValidationProps type definition.