README.md

Agent Zero Documentation

To begin with Agent Zero, follow the links below for detailed guides on various topics:

• Installation: Set up (or update) Agent Zero on your system.
• Quick Start: Begin using Agent Zero with practical examples.
• Usage Guide: Explore advanced features and capabilities.
• Architecture Overview: Understand the internal workings of the framework.
• Contributing: Learn how to contribute to the Agent Zero project.
• Troubleshooting and FAQ: Find answers to common issues and questions.

Your experience with Agent Zero starts now!

• Download Agent Zero: Download the latest release from the GitHub releases page.
• Join the Community: Join the Agent Zero Skool or Discord community to discuss ideas, ask questions, and collaborate with other contributors.
• Share your Work: Share your Agent Zero creations, workflows and discoverings on our Show and Tell area on GitHub.
• Report Issues: Use the GitHub issue tracker to report framework-relative bugs or suggest new features.

Table of Contents

• Welcome to the Agent Zero Documentation
  • Key Features
    • Start your experience with Agent Zero
  • Table of Contents
• Installation guide for Windows, MacOS and Linux
  • Windows Quick Start
  • macOS Quick Start
  • Linux Quick Start
  • In-Depth Guide for Windows and MacOS
    • 1. Install Conda (miniconda)
    • 2. Install Docker (Docker Desktop application)
    • 3. Download Agent Zero
    • 4. Set up Conda environment
    • 5. Configure Agent Zero
    • 6. Run Agent Zero
    • Choosing Your LLMs
      • Installing and Using Ollama
    • How to update Agent Zero
    • How to create executable files for Agent Zero
    • Conclusion
• Quick Start
  • Launching the Web UI
  • Running a Simple Task
  • Example Interaction
  • Next Steps
• Usage Guide
  • Tool Usage
  • Prompt Engineering
  • Example of Tools Usage
  • Memory Management
  • Multi-Agent Cooperation
  • Agent Behavior
  • Using Agent Zero on your mobile device
  • Using code_execution_tool outside of the Docker Container
• Architecture Overview
  • Core Components
  • Agent Hierarchy and Communication
  • Interaction Flow
  • Memory System
  • Tools
  • Knowledge
  • Prompts
  • Extensions
    • Structure of Extensions
    • Types of Default Extensions
  • Key Files
  • Directory Structure
  • Customization
    • Custom Prompts
      • Changing the System Prompt Folder
    • AgentConfig
    • Adding Tools
    • Adding Instruments
    • Adding Extensions
• Contributing to Agent Zero
  • Getting Started
  • Making Changes
  • Submitting a Pull Request
  • Documentation Stack
• FAQ and Troubleshooting
  • Frequently Asked Questions
  • Troubleshooting