Introduction

Welcome to the bot.ts official documentation.

bot.ts banner

What is bot.ts?

bot.ts is a framework for discord.js designed in TypeScript for use in TypeScript. This framework includes all the features you need, here is a list:

• Package Manager Agnostic: Compatible with npm, yarn, pnpm and more.

• Multi-Runtime Support: Fully compatible with Node.js, Bun, and Deno.

• File Handling: Robust file handling using @ghom/handler.

• CLI File Generation: Easy and powerful file generation using @ghom/bot.ts-cli.

• Node Aliases: Simplify module resolution with useful path aliases using Node.js 'imports'.

• Shell Arguments: Handle type-safe shell arguments on textual commands using Yargs.

• Predefined Commands & Listeners: Ready-to-use dev-commands and system-listeners.

• Advanced Scripts: Configured advanced dev tools in package.json's scripts and CLI.

• ORM Setup: Preconfigured Knex-based ORM with sqlite3 using @ghom/orm.

• Pagination: Efficient pagination in the help command.

• Fast Build: Builds fast with Rollup.

• TypeScript Checks: Generated CI/CD using GitHub Actions.

• Logging: Beautiful console logging using @ghom/logger.

• Framework Updates: Stay up to date with the integrated updater.

• Docker: Run with Docker via Dockerfile or compose.yml.

• Data Caching: Reduce database and API requests with built-in caching.

What's next?

• Localhost Admin Dashboard

• Data Caching imporovement

• Make optional the textual command system

• Move all advanced scripts into CLI

• Publish the CLI as JSR package

Why using bot.ts?

Modern, intuitive, and easy to use. Choosing Bot.ts is choosing control.

• It's not a lib! You can edit all files easily.

• All is already configured.

• I recommend it for learning TypeScript.

• It is up to date with all technologies.

Hello World

bot.ts hello world

Annexes

• GitHub - Come contribute 🩵

• Documentation

• Package of CLI on NPM

• Discord to track the progress of the project.

• Community - Les Laboratoires JS

Funding