Skip to content

mcbeet/beet-bot

Repository files navigation

beet-bot

GitHub Actions npm Discord

Packages for the beet bot.

Click the following invite link to add the bot to your own server:

Installation

You can install the beet bot via npm.

$ npm install beet-bot

To run your own instance of the bot use the beet-bot command or simply run it with npx to install it automatically.

$ npx beet-bot --clientId=... --token=...

Usage

You can provide credentials through command-line options --clientId/--token or by using environment variables BEET_BOT_CLIENT_ID/BEET_BOT_TOKEN. The bot will load the .env file in the working directory. The --config option lets you specify a json file in which you can define runner environments.

$ beet-bot --config bot.json

Check out the sample bot.json.

Contributing

This is a monorepo managed with pnpm. If you don't have it installed already check out the standalone script for your platform or get it via Corepack using corepack enable.

$ pnpm install

Set up packages for local development by running pnpm -r stub, and then launch the bot with the required credentials.

$ pnpm dev --clientId=... --token=...

You can also create a .env file at the root of the repository.

BEET_BOT_CLIENT_ID=...
BEET_BOT_TOKEN=...

To build for production use the pnpm -r build command. Note that this overwrites package stubs so you will need to run pnpm -r stub again if you want to resume developing locally.

$ pnpm -r build
$ pnpm start --clientId=... --token=...

The project must type-check and eslint shouldn't report any error.

$ pnpm -r lint

License - MIT