|
# AutoGPT: Build & Use AI Agents |
|
|
|
[![Discord Follow](https://dcbadge.vercel.app/api/server/autogpt?style=flat)](https://discord.gg/autogpt)   |
|
[![Twitter Follow](https://img.shields.io/twitter/follow/Auto_GPT?style=social)](https://twitter.com/Auto_GPT)   |
|
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) |
|
|
|
**AutoGPT** is a powerful tool that lets you create and run intelligent agents. These agents can perform various tasks automatically, making your life easier. |
|
|
|
## How to Get Started |
|
|
|
https://github.com/user-attachments/assets/8508f4dc-b362-4cab-900f-644964a96cdf |
|
|
|
### 𧱠AutoGPT Builder |
|
|
|
The AutoGPT Builder is the frontend. It allows you to design agents using an easy flowchart style. You build your agent by connecting blocks, where each block performs a single action. It's simple and intuitive! |
|
|
|
[Read this guide](https://docs.agpt.co/server/new_blocks/) to learn how to build your own custom blocks. |
|
|
|
### π½ AutoGPT Server |
|
|
|
The AutoGPT Server is the backend. This is where your agents run. Once deployed, agents can be triggered by external sources and can operate continuously. |
|
|
|
### π Example Agents |
|
|
|
Here are two examples of what you can do with AutoGPT: |
|
|
|
1. **Reddit Marketing Agent** |
|
- This agent reads comments on Reddit. |
|
- It looks for people asking about your product. |
|
- It then automatically responds to them. |
|
|
|
2. **YouTube Content Repurposing Agent** |
|
- This agent subscribes to your YouTube channel. |
|
- When you post a new video, it transcribes it. |
|
- It uses AI to write a search engine optimized blog post. |
|
- Then, it publishes this blog post to your Medium account. |
|
|
|
These examples show just a glimpse of what you can achieve with AutoGPT! |
|
|
|
--- |
|
Our mission is to provide the tools, so that you can focus on what matters: |
|
|
|
- ποΈ **Building** - Lay the foundation for something amazing. |
|
- π§ͺ **Testing** - Fine-tune your agent to perfection. |
|
- π€ **Delegating** - Let AI work for you, and have your ideas come to life. |
|
|
|
Be part of the revolution! **AutoGPT** is here to stay, at the forefront of AI innovation. |
|
|
|
**π [Documentation](https://docs.agpt.co)** |
|
 |  |
|
**π [Contributing](CONTRIBUTING.md)** |
|
|
|
|
|
--- |
|
## π€ AutoGPT Classic |
|
> Below is information about the classic version of AutoGPT. |
|
|
|
**π οΈ [Build your own Agent - Quickstart](FORGE-QUICKSTART.md)** |
|
### ποΈ Forge |
|
|
|
**Forge your own agent!** – Forge is a ready-to-go template for your agent application. All the boilerplate code is already handled, letting you channel all your creativity into the things that set *your* agent apart. All tutorials are located [here](https://medium.com/@aiedge/autogpt-forge-e3de53cc58ec). Components from the [`forge.sdk`](/forge/forge/sdk) can also be used individually to speed up development and reduce boilerplate in your agent project. |
|
|
|
π [**Getting Started with Forge**](https://github.com/Significant-Gravitas/AutoGPT/blob/master/forge/tutorials/001_getting_started.md) – |
|
This guide will walk you through the process of creating your own agent and using the benchmark and user interface. |
|
|
|
π [Learn More](https://github.com/Significant-Gravitas/AutoGPT/tree/master/forge) about Forge |
|
|
|
### π― Benchmark |
|
|
|
**Measure your agent's performance!** The `agbenchmark` can be used with any agent that supports the agent protocol, and the integration with the project's [CLI] makes it even easier to use with AutoGPT and forge-based agents. The benchmark offers a stringent testing environment. Our framework allows for autonomous, objective performance evaluations, ensuring your agents are primed for real-world action. |
|
|
|
<!-- TODO: insert visual demonstrating the benchmark --> |
|
|
|
π¦ [`agbenchmark`](https://pypi.org/project/agbenchmark/) on Pypi |
|
 |  |
|
π [Learn More](https://github.com/Significant-Gravitas/AutoGPT/blob/master/benchmark) about the Benchmark |
|
|
|
### π» UI |
|
|
|
**Makes agents easy to use!** The `frontend` gives you a user-friendly interface to control and monitor your agents. It connects to agents through the [agent protocol](#-agent-protocol), ensuring compatibility with many agents from both inside and outside of our ecosystem. |
|
|
|
<!-- TODO: insert screenshot of front end --> |
|
|
|
The frontend works out-of-the-box with all agents in the repo. Just use the [CLI] to run your agent of choice! |
|
|
|
π [Learn More](https://github.com/Significant-Gravitas/AutoGPT/tree/master/frontend) about the Frontend |
|
|
|
### β¨οΈ CLI |
|
|
|
[CLI]: #-cli |
|
|
|
To make it as easy as possible to use all of the tools offered by the repository, a CLI is included at the root of the repo: |
|
|
|
```shell |
|
$ ./run |
|
Usage: cli.py [OPTIONS] COMMAND [ARGS]... |
|
|
|
Options: |
|
--help Show this message and exit. |
|
|
|
Commands: |
|
agent Commands to create, start and stop agents |
|
benchmark Commands to start the benchmark and list tests and categories |
|
setup Installs dependencies needed for your system. |
|
``` |
|
|
|
Just clone the repo, install dependencies with `./run setup`, and you should be good to go! |
|
|
|
## π€ Questions? Problems? Suggestions? |
|
|
|
### Get help - [Discord π¬](https://discord.gg/autogpt) |
|
|
|
[![Join us on Discord](https://invidget.switchblade.xyz/autogpt)](https://discord.gg/autogpt) |
|
|
|
To report a bug or request a feature, create a [GitHub Issue](https://github.com/Significant-Gravitas/AutoGPT/issues/new/choose). Please ensure someone else hasnβt created an issue for the same topic. |
|
|
|
## π€ Sister projects |
|
|
|
### π Agent Protocol |
|
|
|
To maintain a uniform standard and ensure seamless compatibility with many current and future applications, AutoGPT employs the [agent protocol](https://agentprotocol.ai/) standard by the AI Engineer Foundation. This standardizes the communication pathways from your agent to the frontend and benchmark. |
|
|
|
--- |
|
|
|
<p align="center"> |
|
<a href="https://star-history.com/#Significant-Gravitas/AutoGPT"> |
|
<picture> |
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Significant-Gravitas/AutoGPT&type=Date&theme=dark" /> |
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Significant-Gravitas/AutoGPT&type=Date" /> |
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Significant-Gravitas/AutoGPT&type=Date" /> |
|
</picture> |
|
</a> |
|
</p> |
|
|