Skip to content

Installation

1. Download a Release

Choose the archive that matches your machine:

  • osx-arm64 for modern Apple Silicon Macs
  • osx-x64 for older Intel Macs
  • linux-x64 for most Linux servers
  • win-x64 for Windows

Extract the archive somewhere stable. Do not place it inside a temporary download folder you clean out regularly.

2. Run Setup

./brrainzbot setup

The wizard asks for:

  • your Discord bot token
  • your OpenAI-compatible endpoint URL
  • your AI model name
  • your AI API key
  • the Discord IDs for your guild, roles, and welcome channel

It stores:

  • normal config in config.json
  • secrets in secrets.json
  • session state and logs in the same application directory tree

3. Validate Before Going Live

./brrainzbot doctor

Use this every time you change:

  • roles
  • channels
  • bot token
  • AI endpoint
  • guild IDs

4. Start the Bot

./brrainzbot run

5. Repair or Change an Existing Install

./brrainzbot reconfigure

This reruns the guided flow with your current values as defaults.

Optional: Custom Storage Root

You can store the app data somewhere else:

./brrainzbot setup --root /srv/brrainzbot
./brrainzbot run --root /srv/brrainzbot