Package Exports
- @axrxvm/bdjs-cli
- @axrxvm/bdjs-cli/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@axrxvm/bdjs-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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:
- Project Name - What to name your bot
- Language - JavaScript or TypeScript
- Template - Minimal, Basic, or Advanced
- Package Manager - npm, yarn, or pnpm
- 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
Navigate to your project: ```bash cd my-bot ```
Create a `.env` file: ```bash cp .env.example .env ```
Add your Discord bot token to `.env`: ``` DISCORD_TOKEN=your_token_here ```
Start developing: ```bash npm run dev ```
📚 Documentation
🤝 Contributing
Contributions are welcome! Feel free to:
- Report bugs
- Suggest new templates
- Improve documentation
- Submit pull requests
📝 License
MIT © Aarav Mehta