@santerzet/botkit/README.md

CLI for Discord Bot

# 🤖 BotKit

**CLI for Discord Bots**. Build your bot in a few minutes.

## 📦 Features

- Generate a project for Discord Bot easily and quickly
- Create simple bots from a file
- Create a complex bot with components (with prefix commands, slash commands, or both)
- Initialize a git repository automatically
- Automatically installs the necessary dependencies
- Heroku support: You can now initialize a bot and deploy it to Heroku automatically. Requires Heroku CLI.

## 🚀 Getting Started

**Botkit requires Node v16 or higher.**

### 🔧 Installation

It is recommended to install globally so you can use when you need it.

```bash
$ npm install -g @santerzet/botkit
```

If you want to install locally, use

```bash
$ npm install @santerzet/botkit
```

### 📝 Usage

Use botkit to create a bot from global

```bash
$ botkit new

or

$ botkit new <bot-name>
```

Use botkit to create a bot from local

```bash
$ npx botkit new

or

$ npx botkit new <bot-name>
```