disbot-cli v1.3.2

Disbot

Bootstrap Discord bot easily

Install

npm install -g disbot-cli

Usage

You can check CLI help with :

disbot --help

Bot creation

For create a simple project, use:

disbot create <app_name>

You can specify token and/or command prefix with options -t and -p :

disbot create MyApp -t MY_BOT_TOKEN -p /mybot_

Command creation

You can easily create new command for your bot with command generate-command :

disbot generate-command HelloWorld -m "This command show an 'hello world' message"

The option -m is usefull to specify help message. If no specified, the command will not apear on help command

Documentation

The generated project use dotenv. It generate a .env file with basic variable, but you can overwrite theses variables in a local.env file

Bot Commands

The commands are in src/Commands folder and are named like command_name.command.js One command has a name, help string and a execute function.

• The name correspond to the command watched by the bot. For example, a command named foo will executed by the bot if someone write /foo
• The help is for generate help message, if undefined or false, the command will not displayed to help message
• The function accept two parameters, a message object and an array (args)

Project tree

project
├── .env
├── .gitignore
├── README.md
├── package.json
├── src
│   ├── BotHelper.js
│   ├── Commands
│   │   └── Help.command.js
│   └── Logger.js
└── project.js