Skip to content

Quick Start

Supports Mac OS and Linux operating systems. Windows systems can run through docker-compose.

1. Clone the Project

bash
git clone https://github.com/dtyq/magic.git
cd magic

2. Configure Environment Variables

Configure Magic environment variables. You must configure at least one large language model environment variable for proper functionality. Copy the .env.example file to .env and modify the configuration as needed:

bash
cp .env.example .env

3. Start the Service

bash
# Start the service in foreground
./bin/magic.sh start

4. Other Commands

bash
# Display help information
./bin/magic.sh help

# Start the service in foreground
./bin/magic.sh start

# Start the service in background
./bin/magic.sh daemon

# Stop the service
./bin/magic.sh stop

# Restart the service
./bin/magic.sh restart

# Check service status
./bin/magic.sh status

# View service logs
./bin/magic.sh logs

4. Access Services

Released under the Apache 2.0 License