🧠 BorgOS - AI-First Multi-Agent Operating System

BorgOS is an AI-first operating system that integrates multiple AI agents, project management, and deployment automation into a unified platform. It combines the power of Agent Zero, Zenith Coder, and MCP (Model Context Protocol) to create an autonomous development and operations environment.

✨ Key Features

🤖 Multi-Agent System

Agent Zero: Autonomous AI with code execution, web browsing, and memory management
Zenith Coder: Specialized coding assistant with project analysis and generation
MCP Server: Model Context Protocol for enhanced AI interactions
Custom Agents: Extensible framework for specialized agents

📊 Project & Deployment Management

Real-time Monitoring: Track all projects and deployments
Auto-deployment: One-click deployment with automatic port management
Health Tracking: Automatic health checks and error monitoring
Resource Management: CPU and memory limits per deployment

🔍 AI-Powered Search & Memory

Semantic Search: ChromaDB vector database integration
Persistent Memory: Long-term learning and context retention
Knowledge Base: Automatic documentation indexing
Cross-agent Memory: Shared knowledge between agents

🛠️ Developer Experience

Web Dashboard: Beautiful real-time monitoring interface
REST API: Comprehensive API with WebSocket support
Docker-First: Fully containerized architecture
CLI Tools: Command-line interface for all operations

🚀 Quick Start

Option 1: Docker Compose (Recommended)

# Clone the repository
git clone https://github.com/vizi2000/borgos.git
cd borgos

# Copy environment template and add your API keys
cp .env.example .env
nano .env  # Add your OpenAI/Anthropic API keys

# Start all services
docker-compose up -d

# Access the dashboard
open http://localhost:8080

Option 2: Quick Install Script

# One-line installation
curl -fsSL https://raw.githubusercontent.com/vizi2000/borgos/main/install.sh | bash

Option 3: Create Bootable USB (Full Linux Distribution)

# Create bootable BorgOS Linux USB
sudo ./create_full_borgos_usb.sh

📋 System Requirements

Minimum Requirements

OS: Linux (Ubuntu 20.04+, Debian 11+), macOS 12+, Windows with WSL2
RAM: 4GB (8GB recommended)
Storage: 20GB free space
Docker: Version 20.10+
Docker Compose: Version 2.0+

For AI Features

API Keys: OpenAI, Anthropic, or local Ollama
GPU: Optional - NVIDIA GPU for local model inference

🏗️ Architecture

┌─────────────────────────────────────────────┐
│              BorgOS Dashboard               │
│         (React + WebSocket Client)          │
└─────────────────┬───────────────────────────┘
                  │
┌─────────────────▼───────────────────────────┐
│           BorgOS Core API                   │
│  (FastAPI + WebSocket + Background Tasks)   │
└──┬──────────┬──────────┬──────────┬────────┘
   │          │          │          │
┌──▼───┐  ┌──▼───┐  ┌──▼───┐  ┌──▼───┐
│Postgre│  │Redis │  │ChromaDB│ │Docker│
│  SQL  │  │Cache │  │Vectors │ │Engine│
└───────┘  └──────┘  └────────┘ └──────┘
                  │
    ┌─────────────▼───────────────┐
    │      AI Agents Layer        │
    ├─────────────────────────────┤
    │ • Agent Zero                │
    │ • Zenith Coder              │
    │ • MCP Server                │
    │ • Custom Agents             │
    └─────────────────────────────┘

🤖 AI Agents

Agent Zero

Powerful autonomous agent with capabilities:

Code Execution: Write and run code in isolated environments
Web Browsing: Search and extract information from the web
File Operations: Read, write, and manage files
Memory Management: Long-term memory and learning
Task Scheduling: Automated recurring tasks
Tool Creation: Dynamic tool generation

Zenith Coder

Specialized coding assistant featuring:

Project Analysis: Deep understanding of codebases
Code Generation: High-quality code creation
Error Detection: Automatic bug finding
Refactoring: Code improvement suggestions
Documentation: Automatic documentation generation

MCP Server

Model Context Protocol integration providing:

Enhanced Context: Better context management
Tool Registration: Dynamic tool discovery
Cross-agent Communication: Agent coordination
State Management: Persistent state across sessions

📚 API Documentation

Core Endpoints

Projects

GET  /api/v1/projects         # List all projects
POST /api/v1/projects         # Create new project
GET  /api/v1/projects/{id}    # Get project details
POST /api/v1/projects/scan    # Scan for new projects

Deployments

GET  /api/v1/deployments      # List deployments
POST /api/v1/deploy           # Deploy project
POST /api/v1/deployments/{id}/stop    # Stop deployment
POST /api/v1/deployments/{id}/restart # Restart deployment

Agent Zero

GET  /api/v1/agent-zero/status       # Check Agent Zero status
POST /api/v1/agent-zero/start        # Start Agent Zero
POST /api/v1/agent-zero/execute      # Execute task
GET  /api/v1/agent-zero/capabilities # List capabilities

MCP Queries

POST /api/v1/mcp/query               # Execute MCP query
GET  /api/v1/mcp/tools               # List available tools

🚢 Deployment Options

Development

docker-compose up -d

Production

docker-compose -f docker-compose.prod.yml up -d

Kubernetes

kubectl apply -f k8s/

Bare Metal

sudo ./installer/install-to-disk.sh

🔧 Configuration

Configuration via environment variables in .env:

# API Keys
OPENAI_API_KEY=your-openai-key
ANTHROPIC_API_KEY=your-anthropic-key
OLLAMA_API_BASE_URL=http://localhost:11434

# Database
DB_HOST=postgres
DB_PORT=5432
DB_NAME=borgos
DB_USER=borgos
DB_PASSWORD=secure-password

# Features
AGENT_ZERO_ENABLED=true
ZENITH_ENABLED=true
MCP_ENABLED=true
AGENT_ZERO_AUTOSTART=false

# Ports
API_PORT=8081
DASHBOARD_PORT=8080
AGENT_ZERO_PORT=8085

📁 Project Structure

borgos/
├── core/                    # Core API server
│   ├── main.py             # FastAPI application
│   ├── agent_zero_integration.py
│   ├── zenith_integration.py
│   ├── mcp_server.py
│   └── vector_store.py
├── webui/                   # Dashboard UI
│   ├── index.html
│   └── static/
├── database/                # Database schemas
│   └── init.sql
├── docker/                  # Docker configurations
│   ├── Dockerfile.api
│   └── Dockerfile.dashboard
├── installer/               # Installation scripts
│   ├── install-to-disk.sh
│   └── quick-install.sh
├── docs/                    # Documentation
└── docker-compose.yml       # Main compose file

🛠️ Development

Setup Development Environment

# Clone repository
git clone https://github.com/yourusername/borgos.git
cd borgos

# Install dependencies
pip install -r requirements-dev.txt

# Run tests
pytest tests/

# Start development server
python core/main.py

Running Tests

# Unit tests
pytest tests/unit/

# Integration tests
pytest tests/integration/

# Coverage report
pytest --cov=core --cov-report=html

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for:

Code of conduct
Development setup
Pull request process
Coding standards

How to Contribute

Fork the repository
Create a feature branch (git checkout -b feature/amazing)
Commit changes (git commit -m 'Add amazing feature')
Push to branch (git push origin feature/amazing)
Open a Pull Request

📖 Documentation

🐛 Troubleshooting

Common Issues

Docker containers not starting

# Check logs
docker-compose logs -f

# Restart services
docker-compose restart

# Clean restart
docker-compose down -v
docker-compose up -d

Agent Zero not responding

# Check status
curl http://localhost:8081/api/v1/agent-zero/status

# Restart Agent Zero
curl -X POST http://localhost:8081/api/v1/agent-zero/restart

Database connection issues

# Check PostgreSQL
docker-compose logs postgres

# Reset database
docker-compose down -v
docker-compose up -d

🗺️ Roadmap

v2.1 - Kubernetes deployment support
v2.2 - Multi-user authentication
v2.3 - Plugin marketplace
v2.4 - Mobile application
v2.5 - Voice interface
v3.0 - Distributed agent coordination
Future - Quantum computing integration

📊 Performance

API Response Time: <100ms average
Agent Task Execution: 2-10s depending on complexity
Memory Usage: ~500MB base, 2GB with all agents
Concurrent Users: 100+ supported
Project Scanning: 1000+ files/second

🔒 Security

Authentication: JWT-based authentication
Authorization: Role-based access control
Encryption: TLS 1.3 for all communications
Sandboxing: Isolated execution environments
Audit Logging: Complete audit trail

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Agent Zero by frdel
Zenith Coder community
MCP by Anthropic
FastAPI by Sebastián Ramírez
ChromaDB team
All contributors and supporters

💬 Support

Documentation: docs.borgos.ai
Issues: GitHub Issues
Discussions: GitHub Discussions
Discord: Join our Discord
Twitter: @BorgOSAI

⭐ Star History

Made with ❤️ by the BorgOS Team

Website • Documentation • Live Demo • Twitter

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
.ci		.ci
.github/workflows		.github/workflows
assets		assets
branding		branding
core		core
database		database
deploy		deploy
docs		docs
installer		installer
iso-builder		iso-builder
iso_build		iso_build
k8s		k8s
mcp_servers		mcp_servers
offline-packages		offline-packages
plugins		plugins
scripts		scripts
tests		tests
website		website
webui		webui
.env.example		.env.example
.gitignore		.gitignore
.gitlab-ci.yml		.gitlab-ci.yml
BUILD_ISO_README.md		BUILD_ISO_README.md
CLAUDE.md		CLAUDE.md
CONTRIBUTING.md		CONTRIBUTING.md
CREATE_BOOTABLE_USB.md		CREATE_BOOTABLE_USB.md
DEPLOYMENT_GUIDE.md		DEPLOYMENT_GUIDE.md
Dockerfile.api		Dockerfile.api
Dockerfile.borgos-fixed		Dockerfile.borgos-fixed
Dockerfile.dashboard		Dockerfile.dashboard
Dockerfile.fulliso		Dockerfile.fulliso
Dockerfile.iso-builder		Dockerfile.iso-builder
Dockerfile.isobuilder		Dockerfile.isobuilder
Dockerfile.vm		Dockerfile.vm
Dockerfile.vm-test		Dockerfile.vm-test
Dockerfile.website		Dockerfile.website
INSTALL_FROM_USB.md		INSTALL_FROM_USB.md
INSTALL_INSTRUCTIONS.txt		INSTALL_INSTRUCTIONS.txt
Jenkinsfile		Jenkinsfile
LICENSE		LICENSE
Makefile		Makefile
QUICK_USB_GUIDE.md		QUICK_USB_GUIDE.md
README.md		README.md
README_DASHBOARD.md		README_DASHBOARD.md
README_OLD.md		README_OLD.md
auto_create_usb.sh		auto_create_usb.sh
bfg.jar		bfg.jar
borg_cli.py		borg_cli.py
borg_os_readme_planning.md		borg_os_readme_planning.md
build-and-test-iso.sh		build-and-test-iso.sh
build-borgos-iso.sh		build-borgos-iso.sh
build-complete-iso-2025.sh		build-complete-iso-2025.sh
build-full-iso-fixed.sh		build-full-iso-fixed.sh
build-full-x86-iso.sh		build-full-x86-iso.sh
build-hybrid-arm.sh		build-hybrid-arm.sh
build-hybrid-docker.sh		build-hybrid-docker.sh
build-hybrid-iso.sh		build-hybrid-iso.sh
build-iso-internal.sh		build-iso-internal.sh
build-offline-iso.sh		build-offline-iso.sh
build-working-iso.sh		build-working-iso.sh
build-x86-iso-on-arm.sh		build-x86-iso-on-arm.sh
build-x86-iso.sh		build-x86-iso.sh
build_iso_docker.sh		build_iso_docker.sh
build_iso_with_docker.sh		build_iso_with_docker.sh
complete_install.sh		complete_install.sh
create-iso-2025.sh		create-iso-2025.sh
create-iso-quick.sh		create-iso-quick.sh
create_bootable_usb.sh		create_bootable_usb.sh
create_complete_iso.sh		create_complete_iso.sh
create_offline_package.sh		create_offline_package.sh
create_usb_fixed.sh		create_usb_fixed.sh
create_usb_macos.sh		create_usb_macos.sh
deploy-aiuser.sh		deploy-aiuser.sh
deploy-quick.sh		deploy-quick.sh
deploy-remote.sh		deploy-remote.sh
deploy-with-sudo.sh		deploy-with-sudo.sh
deploy.sh		deploy.sh
docker-compose-build.yml		docker-compose-build.yml
docker-compose-full.yml		docker-compose-full.yml
docker-compose-remote.yml		docker-compose-remote.yml
docker-compose-simple.yml		docker-compose-simple.yml
docker-compose-with-agent-zero.yml		docker-compose-with-agent-zero.yml
docker-compose.yml		docker-compose.yml
docker_build_iso.sh		docker_build_iso.sh
download_models_offline.sh		download_models_offline.sh
fix-borgos.sh		fix-borgos.sh
fix-docker-aiuser.sh		fix-docker-aiuser.sh
flash_usb_macos.sh		flash_usb_macos.sh
install.sh		install.sh
manual_usb_steps.md		manual_usb_steps.md
model_manager.py		model_manager.py
package.json		package.json
prepare-for-pc-build.sh		prepare-for-pc-build.sh
prepare_usb_simple.sh		prepare_usb_simple.sh
push-to-github.sh		push-to-github.sh
quick-install.sh		quick-install.sh
quick_vm_test.sh		quick_vm_test.sh
requirements.txt		requirements.txt
setup-pc-build.sh		setup-pc-build.sh
setup-windows-wsl.sh		setup-windows-wsl.sh

License

vizi2000/borgos

Folders and files

Latest commit

History

Repository files navigation

🧠 BorgOS - AI-First Multi-Agent Operating System

✨ Key Features

🤖 Multi-Agent System

📊 Project & Deployment Management

🔍 AI-Powered Search & Memory

🛠️ Developer Experience

🚀 Quick Start

Option 1: Docker Compose (Recommended)

Option 2: Quick Install Script

Option 3: Create Bootable USB (Full Linux Distribution)

📋 System Requirements

Minimum Requirements

For AI Features

🏗️ Architecture

🤖 AI Agents

Agent Zero

Zenith Coder

MCP Server

📚 API Documentation

Core Endpoints

Projects

Deployments

Agent Zero

MCP Queries

🚢 Deployment Options

Development

Production

Kubernetes

Bare Metal

🔧 Configuration

📁 Project Structure

🛠️ Development

Setup Development Environment

Running Tests

🤝 Contributing

How to Contribute

📖 Documentation

🐛 Troubleshooting

Common Issues

🗺️ Roadmap

📊 Performance

🔒 Security

📝 License

🙏 Acknowledgments

💬 Support

⭐ Star History

About

Topics

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases 1

Packages 0

Languages

Packages