Project Command

The botbox project command provides project-level management tools, including configuration upgrades.


Usage

To see available subcommands:

sh
botbox project --help

Upgrade Project Configuration

The most common subcommand is upgrade, which updates your botbox.conf to the latest schema.

Upgrade your project:

sh
botbox project upgrade

What this does:

  • Backs up your current botbox.conf
  • Parses your cog files to extract command info
  • Converts legacy config formats to the latest schema
  • Preserves all your existing settings

What Does botbox project upgrade Change?

If your project uses an older config format (pre-2.5.0), the upgrade will convert your cog command arrays to the new, detailed object format.

{
  "cogs": [
    {
      "name": "HelloWorld",
      "file": "helloWorld",
      "env": "development",
      "slash_commands": [
        {
          "Name": "hello",
          "Scope": "guild",
          "Type": "slash",
          "Description": "Bot responds with world",
          "Args": [],
          "ReturnType": "None"
        }
      ],
      "prefix_commands": []
    }
  ]
}

After upgrading:

  • Each command is a full object with name, type, description, args, and return type.
  • Your old config is backed up as botbox.conf.backup.

When to Use

  • You have an older BotBox project and want to use new features
  • You see warnings about legacy config formats

Example Output

plaintext
šŸ” Analyzing botbox.conf for upgrade...
āœ… Upgrade completed successfully!
šŸ’¾ Backup created: botbox.conf.backup
šŸ“¦ Upgraded cogs: HelloWorld, Music
šŸŽ‰ Upgrade completed successfully!
šŸ’” Run 'botbox config sync' to ensure everything is synchronized.

Next Steps