Installation Guide - Beep.AI Documentation

Beep.AI.Server Installation

Prerequisites

Python 3.11 or higher
pip (Python package manager)
Git
Windows, macOS, or Linux

Easy Deploy (Non-Technical Users)

Double-click Install-Beep.AI.Server.bat (Windows) or run:

python easy_deploy.py

Fresh Install — Complete setup with one click
Upgrade — Preserves all data, configurations, and database

Developer Install from Source

git clone https://github.com/The-Tech-Idea/Beep.AI.Server.git
cd Beep.AI.Server/Beep.AI.Server

# Create and activate virtual environment
python -m venv .venv
# Windows:
.venv\Scripts\activate
# Linux/macOS:
source .venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Initialize the database
python init_database.py

# Start the server
python run.py

Server will be available at http://localhost:5000.

Tip

The first run opens the Setup Wizard which guides you through initial configuration, database setup, and admin account creation.

Configuration

Copy the example environment file and customize:

cp .env.example .env

Variable	Purpose	Default
`SQLALCHEMY_DATABASE_URI`	Database connection	`sqlite:///app.db`
`SECRET_KEY`	Flask session signing	(auto-generated)
`BEEP_JWT_SECRET`	JWT token signing	(auto-generated)
`CELERY_ENABLED`	Enable Celery tasks	false
`REDIS_MANAGED`	Auto-start Redis	false

Beep.AI.SDK Installation

Python SDK

pip install beep-ai-sdk

JavaScript SDK

npm install @beep-ai/sdk

.NET SDK

dotnet add package Beep.AI.SDK

Go SDK

go get github.com/The-Tech-Idea/beep-ai-sdk-go

See SDK Overview for all 15 language targets.

Beep.AI.Clients Installation

Desktop Client

Download the installer for your platform from the releases page. The desktop client bundles its own runtime.

Web Client

cd Beep.AI.Clients/Web
npm install
npm run build

CLI Client

dotnet tool install --global Beep.AI.CLI