Getting Started

Important

Lilybird does not officially support deno. While the core should work, there’s no guarantee that the modules or, for that matter the examples will.

Installation

The fastest way to get started with Lilybird is by using our template generator.

bun

bun create @lilybird

npm

npm create @lilybird

pnpm

pnpm create @lilybird

yarn

yarn create @lilybird

Running your first bot

After running the command you should see a file structure somewhat like this:

Note

Depending on the selected language for the template the structure may differ: The JavaScript template will not contain type or config files (globals.d.ts and tsconfig.json)

• globals.d.ts
• tsconfig.json
• package.json
• .env <- add your token here
• Directorysrc

  • index.ts

Adding your token

To add your bot token open your .env file and add the token after TOKEN=.

Starting your bot

Tip

If you are using Bun you can run bun start no matter what language you are using.

TypeScript

npm run dev

JavaScript

npm run start

Ready for production

If you are using TypeScript we highly recommend adding NODE_ENV="production" to your .env file and if you are using Node, do the following.

Note

If you are using Bun we highly encourage changing or adding a script to run production using bun --smol.

npm run build
npm run start