/bot

A bot

Primary LanguageJavaScriptThe UnlicenseUnlicense

BOT

What is it ?

It is a simple CLI for running commands.

To add a command, you just have to copy its code in the commands folder.

Getting started

Prerequisite

Install Git : https://git-scm.com/downloads

Install Node : https://github.com/coreybutler/nvm-windows

Install Yarn : https://yarnpkg.com/lang/en/docs/install/

First run

Clone this repo : git clone https://github.com/acailly/bot.git

Got to folder bot : cd bot

Run Yarn to download dependencies : yarn

Run the bot to check it works : yarn start

Once the bot started, type help to show available commands.

For the moment no command is available.

Add a command - easy way

Run the bot and type the command add https://insert_the_command_repo_url

Add a command - normal way

Create the folder commands

Go in this folder : cd commands

Clone the code of the say command : git clone https://github.com/acailly/bot-say.git

Go back in the parent folder : cd ..

Run the bot to check it works : yarn start

Once the bot started, type help to show available commands.

The command say has appeared \o/.

Type say hello and the bot say hello

Configuration

Some commands needs parameters.

To set these parameters, create a file named config.yaml in the same folder of the LICENSE file.

See each command documentation to know what to write in this file.

Commands

Available commands are:

If you create some interesting command, please tell me or make a PR ;-)