View on GitHub

Init Command

The botbox init command initializes a new BotBox project in your current directory.
Use this if you want to turn an existing folder into a BotBox-managed Discord bot project.

Usage

sh
botbox init

You’ll be guided through an interactive setup to provide:

  • Bot name
  • Description
  • Author
  • Command prefix
  • Environment variable setup (.env or Doppler)
  • License type

What Does It Do?

  • Creates a botbox.conf config file
  • Sets up the recommended project structure
  • Adds a sample cog (helloWorld.py)
  • Generates a run.sh script and optional files (LICENSE, .env, or doppler.yaml)

Example Structure

plaintext
your-bot/
├── README.md
├── botbox.conf
├── requirements.txt
├── run.sh
├── .env (or doppler.yaml)
├── .gitignore
├── LICENSE
├── src/
│   ├── main.py
│   ├── cogs/
│   │   ├── __init__.py
│   │   ├── helloWorld.py
│   │   └── cogs.py
│   └── utils/
│       ├── __init__.py
│       └── logger.py

Headless Usage

init takes the same flags as create and writes into the current directory.

sh
botbox init --name MyBot --description "A really cool bot" --author "John Doe"

Use --force to overwrite files that already exist without being prompted. See Headless Mode for the full flag list.

When to Use

  • You have an existing directory and want to start fresh with BotBox
  • You want to re-initialize a project with updated config

Next Steps