Documentation

Developer Documentation

Everything you need to build, deploy, and extend reagent

Quick Start Guide

Get reagent up and running in minutes with this step-by-step guide.

Clone Repository

git clone https://github.com/reagent-systems/reagent.git
cd reagent

Install Dependencies

pip install -r requirements.txt

Configure Environment

cp .env.example .env
# Edit .env with your API keys

Run Agent

python SimpleAgent.py -a 10 "Your task here"

Installation

System Requirements

Python 3.8+

Required for core functionality

4GB RAM

Minimum recommended memory

1GB Storage

For installation and workspace

Installation Methods

From Source (Recommended)

git clone https://github.com/reagent-systems/reagent.git
cd reagent
pip install -r requirements.txt

Docker

docker pull reagent/reagent:latest
docker run -it reagent/reagent

Configuration

Environment Variables

OPENAI_API_KEY

Your OpenAI API key for GPT models

Required

GEMINI_API_KEY

Google Gemini API key (optional)

Optional

LM_STUDIO_URL

LM Studio server URL for local models

Optional

GITHUB_TOKEN

GitHub personal access token

Optional

Example .env File

# AI Provider Configuration
OPENAI_API_KEY=your_openai_api_key_here
GEMINI_API_KEY=your_gemini_api_key_here
LM_STUDIO_URL=http://localhost:1234

# GitHub Integration
GITHUB_TOKEN=your_github_token_here

# Agent Configuration
MAX_STEPS=15
AUTO_CONTINUE_STEPS=10
TOOLS_REPO_URL=https://github.com/reagent-systems/reagent-tools

# Web Interface
SECRET_KEY=your_secret_key_here
WEBSOCKET_URL=ws://localhost:8765

API Reference

REST API Endpoints

GET

/api/status

Get system status and health information

POST

/api/agent/execute

Execute a command through the agent

GET

/api/files

List generated files

GET

/api/tools

Get available tools and commands

WebSocket Events

agent_response

Receive agent responses and status updates

step_update

Real-time step execution updates

file_created

Notification when files are created

error

Error messages and exceptions

Examples

Create a Python Script

python SimpleAgent.py -a 5 "Create a Python script that calculates the Fibonacci sequence up to n=20 and saves it to fibonacci.py"

Web Research

python SimpleAgent.py -a 10 "Research the latest developments in AI and create a summary report"

Data Analysis

python SimpleAgent.py -a 15 "Analyze the CSV file data.csv and create visualizations showing trends"

GitHub Operations

python SimpleAgent.py -a 8 "Clone the repository user/repo and analyze its structure"

API Status

Checking API status...

View Raw API Response