BDJS CLI

The official CLI tool for creating BetterDiscordJS bots.

🚀 Quick Start

Create a new Discord bot project:

```bash npx @axrxvm/bdjs-cli-cli create ```

Or with a project name:

```bash npx @axrxvm/bdjs-cli create my-awesome-bot ```

✨ Features

• Interactive Setup - Beautiful CLI prompts guide you through project creation
• Multiple Templates - Choose from minimal, basic, or advanced templates
• Language Support - Full support for both JavaScript and TypeScript
• Auto-Configuration - Automatically sets up package.json, tsconfig, eslint, and more
• Package Manager Choice - Use npm, yarn, or pnpm
• Git Integration - Optional git repository initialization

📋 Templates

Minimal

Perfect for quick prototypes and learning:

• Basic bot setup
• One example command
• Minimal dependencies
• Quick to understand

Basic

Great for small to medium bots:

• Organized file structure
• Multiple example commands
• Event handlers
• Configuration system
• Embed builders

Advanced

Production-ready setup:

• Full project structure
• Command categories
• Middleware system (cooldowns, permissions)
• Advanced logging
• Error handling
• TypeScript support with path aliases
• ESLint configuration
• Best practices

🎯 Usage Examples

JavaScript - Minimal Template

```bash npx @axrxvm/bdjs-cli create

Select: JavaScript → Minimal → npm

```

Results in: ``` my-bot/ ├── index.js ├── package.json ├── .env.example ├── .gitignore └── README.md ```

TypeScript - Advanced Template

```bash npx @axrxvm/bdjs-cli create my-bot

Select: TypeScript → Advanced → pnpm

```

Results in: ``` my-bot/ ├── src/ │ ├── commands/ │ │ ├── utility/ │ │ ├── moderation/ │ │ └── fun/ │ ├── events/ │ ├── middleware/ │ ├── config/ │ ├── utils/ │ ├── types/ │ └── index.ts ├── package.json ├── tsconfig.json ├── .eslintrc.json ├── .env.example ├── .gitignore └── README.md ```

🔧 Command Options

```bash npx @axrxvm/bdjs-cli create [options]

Options: -v, --version Show version number -h, --help Show help ```

🎨 Interactive Prompts

The CLI will ask you:

1. Project Name - What to name your bot
2. Language - JavaScript or TypeScript
3. Template - Minimal, Basic, or Advanced
4. Package Manager - npm, yarn, or pnpm
5. Git Init - Whether to initialize a git repository

📦 What Gets Installed

Minimal Template

• @axrxvm/bdjs-cli
• discord.js
• dotenv

Basic Template

Additional:

• eslint (dev)

Advanced Template

Additional:

• chalk
• eslint + typescript-eslint (dev)
• ts-node-dev (TS only)

🚦 After Creation

1. Navigate to your project: ```bash cd my-bot ```

2. Create a `.env` file: ```bash cp .env.example .env ```

3. Add your Discord bot token to `.env`: ``` DISCORD_TOKEN=your_token_here ```

4. Start developing: ```bash npm run dev ```

📚 Documentation

• BetterDiscordJS Documentation
• Discord.js Guide
• Discord Developer Portal

🤝 Contributing

Contributions are welcome! Feel free to:

• Report bugs
• Suggest new templates
• Improve documentation
• Submit pull requests

📝 License

MIT © Aarav Mehta

🔗 Links

• GitHub Repository
• npm Package
• Discord Support Server