Skip to content
TomoriBot

How do I use TomoriBot?

This guide takes you from scratch to your first message with TomoriBot. You can either invite the ready public instance or self-host your own, then complete setup inside Discord.

1. Add TomoriBot to Discord

Option A: Invite the Hosted Bot

For convenience, you can invite the public instance with the button below, then pick the server you want her in. (You can also DM her directly) You need the Manage Server permission to add a bot.

Invite TomoriBot

Option B: Self-Host Your Own

If you prefer full control over your privacy and data, you can run your own TomoriBot instance on your own hardware:

  • Option 1: Setup Wizard (Recommended): requires Bun v1.3.2+, PostgreSQL or Docker, and a Discord bot token with Presence Intent, Server Members Intent, and Message Content Intent enabled:
    Terminal window
    git clone https://github.com/Bredrumb/TomoriBot.git
    cd TomoriBot
    bun run setup # installs dependencies, configures .env, and sets up PostgreSQL
    bun run dev # starts the bot and runs DB migrations automatically
  • Option 2: Docker Compose: requires Docker and Docker Compose v2+, and a Discord bot token with the same three intents enabled:
    Terminal window
    git clone https://github.com/Bredrumb/TomoriBot.git
    cd TomoriBot
    cp .env.example .env # set DISCORD_TOKEN, CRYPTO_SECRET, POSTGRES_PASSWORD, and ALLOW_PRIVATE_NETWORK
    docker compose up

After, invite her to any server you have Manage Server permissions in, or talk to her in DMs.

Full Self-Hosting Guides

2. Run /setup

Run /setup, accomplish all items and then press Finish Setup:

  • AI Provider: choose AI Provider (Recommended), pick your provider, and paste the key in. Self-hosters can choose Custom Endpoint to register an endpoint connection and text model. In a server, User BYOK lets every member supply their own personal provider.
  • Starting Settings: pick a starting persona, a reply style, a timezone, default system prompt, and optional features. All nine optional features start checked; uncheck any you do not want. You can adjust these settings later in /config.

Nothing is saved while you work: the panel is a draft, Finish Setup is what encrypts the key, initializes her configuration for the server, and gets her ready to talk. Cancel discards the draft, and an untouched panel expires on its own. Each server keeps its own independent configuration.

As a recommended follow-up, run /expressions initialize so she can use your server’s custom emojis and stickers accurately.

3. Start Chatting

Mention her or reply to one of her messages (or slide into her DMs and say hi):

@TomoriBot yo, what's up?

Basic Commands & Next Steps

  • /setup: Initial bot setup for your server.
  • /config and /personal config: Tweak TomoriBot in the current Discord server or for yourself.
  • /providers and /personal providers: Add more model endpoints or cloud providers.
  • /persona: Give her a personality or add new characters. See Multiple Personas.
  • /memories: Teach her facts across conversations. See Memory.

Explore other customization options in the Command Reference or Features tour.