https://github.com/basedhardware/omi-faq-bot
Discord bot for FAQ questions
https://github.com/basedhardware/omi-faq-bot
Last synced: 3 months ago
JSON representation
Discord bot for FAQ questions
- Host: GitHub
- URL: https://github.com/basedhardware/omi-faq-bot
- Owner: BasedHardware
- Created: 2025-09-26T12:03:42.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-09-30T19:36:33.000Z (3 months ago)
- Last Synced: 2025-09-30T21:25:39.479Z (3 months ago)
- Language: Python
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Omi Discord Bot
## How to Run
```bash
# package manager
uv
````
### Installation
* Clone the repository
* Create a virtual environment:
```bash
uv venv env
```
* Activate the virtual environment:
```bash
source env/bin/activate
```
* Install dependencies:
```bash
uv pip install -r requirements.txt
```
### Configuration
Create a `.env` file in the project root and add your bot token:
```env
TOKEN=your_bot_token
// DEFAULT IS OPENAI
OPENAI_API_KEY=
GEMINI_API_KEY=
```
### Running the Bot
```bash
# Run the bot
python main.py
# Run with auto-restart on file changes
watchmedo auto-restart --recursive --pattern="*.py" -- python main.py
```
### Indexing the Knowledge Base
In your Discord server, run:
```
$index
```
---
## Commands
* `$index` — Indexes the `faq.json` file
* `$reload_index` — Reloads the BM25 index
* `$sync` — Syncs slash commands
---