Creating your first slash command

Before starting:

Global commands are available on all your app's guilds. Global commands are cached for 1 hour. That means that new global commands will fan out slowly across all guilds, and will be guaranteed to be updated in an hour.

Reference: https://bit.ly/3nGQrqF

Simple Slash Command

To create a slash command works a little differently, but following the same logic. Let's start with something basic.

JavaScript

commands/ping.js

const command = {
  name: 'ping',
  descriptions: 'Ping! Pong!',
  guilds: 'YOUR_GUILD_ID',
  isSlashCommand: true,
  
  execute: async (client, interaction, sender, instance) => {
    interaction.reply('Pong!');
  }
};

module.exports = { command };

TypeScript

commands/ping.ts

import { SlashCommand } from 'seface-kit';

export const command: SlashCommand = {
  name: 'ping',
  descriptions: 'Ping! Pong!',
  guilds: 'YOUR_GUILD_ID',
  isSlashCommand: true,
  
  execute: async (client, interaction, sender, instance) => {
    interaction.reply('Pong!');
  }
};

Remember, you must name the constant as command, otherwise the TypeError: Cannot read properties of undefined error will be returned.

You can register slash commands globally or per guilds. See below for ways to register commands:

guilds: 'GUILD_ID' // Register the command in the indicated guild.
guilds: ['GUILD_ID_1'] // Register the command in the indicated guild.
guilds: ['GUILD_ID_1', 'GUILD_ID_2'] // Register the command in the indicated guilds.
guilds: [] // Register the command globally.

// If guild property is not set, the command will be registered globally.

Advanced Slash Command

The way that the slash commands work with options/arguments is different and better for the user to see, as the options are presented as soon as they start typing in the chat. See below how to add options and use their user-submitted values.

JavaScript

commands/moderation/kick.js

const command = {
  name: 'kick',
  description: 'Kick members from the server.',
  options: [
    // Type definitions can be found here: https://bit.ly/3n117So
    { name: 'user', description: 'User to be kicked', type: 6, required: true },
    { name: 'reason', description: 'Reason for the kick', type: 3 }
  ],
  guilds: 'GUILD_ID',
  isSlashCommand: true,
  
  execute: async (client, interaction, sender, instance) => {
    const guild = await instance.utils.guild.getGuildByName('GUILD_NAME');
    
    // Fetch Options Values
    const user = interaction.options.getUser('user'); // Need convert the User to GuildMember type.
    const reason = interaction.options.getString('reason');
    
    const userToKick = guild.members.cache.get(user.id);
    
    if(!sender.permissions.has('KICK_MEMBERS')) {
      return interaction.reply('You don\'t have permission to use this command!');
    }
    
    if(!userToKick.kickable) {
      return interaction.reply('You can\'t kick this user!');
    }
    
    userToKick.kick(reason);
    interaction.reply('User kicked!');
  }
};

module.exports = { command };

TypeScript

commands/moderation/kick.ts

import { SlashCommand } from 'seface-kit';

export const command: SlashCommand = {
  name: 'kick',
  description: 'Kick members from the server.',
  options: [
    // Type definitions can be found here: https://bit.ly/3n117So
    { name: 'user', description: 'User to be kicked', type: 6, required: true },
    { name: 'reason', description: 'Reason for the kick', type: 3 }
  ],
  guilds: 'GUILD_ID',
  isSlashCommand: true,
  
  execute: async (client, interaction, sender, instance) => {
    const guild = await instance.utils.guild.getGuildByName('GUILD_NAME');
    
    // Fetch Options Values
    const user = interaction.options.getUser('user'); // Need convert the User to GuildMember type.
    const reason = interaction.options.getString('reason');
    
    const userToKick = guild.members.cache.get(user.id);
    
    if(!sender.permissions.has('KICK_MEMBERS')) {
      return interaction.reply('You don\'t have permission to use this command!');
    }
    
    if(!userToKick.kickable) {
      return interaction.reply('You can\'t kick this user!');
    }
    
    userToKick.kick(reason);
    interaction.reply('User kicked!');
  }
};

Adding permissions