Welcome to the AgentBeats documentation! This directory contains comprehensive guides for using, developing, and deploying AgentBeats.
- README - Overview and quick start guide for AgentBeats
- System Overview - High-level architecture and component overview
- Self-Hosting Guide - Complete guide for hosting AgentBeats services locally or in production
- CLI Reference - Complete command-line interface documentation
- Agent Integration and Customization - Guide for creating and customizing AI agents (Coming Soon)
- Backend API Specification - OpenAPI specification for the REST API
- Source Code Structure - Overview of the codebase organization
agentbeats/
├── README.md # Main project overview and quick start
├── docs/ # Documentation directory
│ ├── README.md # This documentation index
│ ├── self_host_instruction.md # Hosting and deployment guide
│ ├── system_overview.md # System architecture overview
│ ├── cli-reference.md # CLI usage documentation
│ ├── agent_integration_and_customization.md # Agent development guide
│ └── backend_openapi.yaml # API specification
├── src/ # Source code directory
│ └── README.md # Source code structure overview
└── [other project files...]