Quick start

Setup guide

The fastest path from a fresh clone to a working NanoBot instance, presented in mobile-friendly steps.

Clone and enter repo

git clone https://github.com/therealjustsnow/NanoBot.git
cd NanoBot

Create a virtual environment and install dependencies

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Create config.ini

Copy example_config.ini to config.ini, then fill in at least the bot token.

[bot]
token = YOUR_BOT_TOKEN_HERE
default_prefix = n!
owner_id =

[groq]
groq_api_key =

Enable Discord intents

Server Members Intent
Message Content Intent

Without both intents, prefix commands and several moderation workflows will fail.

Run preflight

python run.py

The repository includes a preflight check before a full bot launch.

Launch bot

python main.py

Logs write to logs/nanobot.log.

Minimal success path

What is required

Python 3.11 or newer.
Discord bot token.
Enabled Server Members and Message Content intents.
Installed requirements from requirements.txt.

Optional now, useful later

Features that need extra config

GROQ_API_KEY or [groq] groq_api_key for /eli5.
Bot-list tokens for vote webhooks and posting.
[bot] owner_id if you want explicit owner override.

Shortcut

One-command install and launch

Platform scripts wrap the steps above: install.sh / install.ps1 / install.bat set up system packages, a virtual environment, dependencies, and config.ini; run.sh / run.bat pick a suitable Python and hand off to the preflight launcher.

./install.sh   # Linux/macOS — or install.ps1 / install.bat on Windows
./run.sh       # launch (run.bat on Windows)