AutoGPT/README.md

135 lines
6.2 KiB
Markdown
Raw Normal View History

2024-07-15 21:31:30 +00:00
# AutoGPT: Build & Use AI Agents
2023-04-17 00:22:18 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
[![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)
2023-04-17 00:22:18 +00:00
2024-07-15 21:29:03 +00:00
**AutoGPT** is a powerful tool that lets you create and run intelligent agents. These agents can perform various tasks automatically, making your life easier.
2024-07-15 21:29:03 +00:00
## How to Get Started
2024-09-24 19:03:41 +00:00
https://github.com/user-attachments/assets/d04273a5-b36a-4a37-818e-f631ce72d603
2024-07-15 21:29:03 +00:00
### 🧱 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!
2024-07-18 23:46:17 +00:00
[Read this guide](https://docs.agpt.co/server/new_blocks/) to learn how to build your own custom blocks.
2024-07-15 21:29:03 +00:00
### 💽 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:
2023-09-12 04:34:24 +00:00
- 🏗️ **Building** - Lay the foundation for something amazing.
- 🧪 **Testing** - Fine-tune your agent to perfection.
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
- 🤝 **Delegating** - Let AI work for you, and have your ideas come to life.
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
Be part of the revolution! **AutoGPT** is here to stay, at the forefront of AI innovation.
2023-05-26 21:05:58 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
**📖 [Documentation](https://docs.agpt.co)**
 | 
**🚀 [Contributing](CONTRIBUTING.md)**
2023-05-26 21:05:58 +00:00
2023-09-12 04:34:24 +00:00
2024-07-15 21:29:03 +00:00
---
## 🤖 AutoGPT Classic
> Below is information about the classic version of AutoGPT.
**🛠️ [Build your own Agent - Quickstart](classic/FORGE-QUICKSTART.md)**
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
### 🏗️ Forge
2023-09-12 04:34:24 +00:00
**Forge your own agent!** – Forge is a ready-to-go toolkit to build your own agent application. It handles most of the boilerplate code, 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 [`forge`](/classic/forge/) can also be used individually to speed up development and reduce boilerplate in your agent project.
2023-09-12 04:34:24 +00:00
🚀 [**Getting Started with Forge**](https://github.com/Significant-Gravitas/AutoGPT/blob/master/classic/forge/tutorials/001_getting_started.md) –
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
This guide will walk you through the process of creating your own agent and using the benchmark and user interface.
2023-09-12 04:34:24 +00:00
📘 [Learn More](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/forge) about Forge
2023-09-25 17:18:07 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
### 🎯 Benchmark
2023-09-12 04:34:24 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
**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.
2023-05-26 21:05:58 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
<!-- TODO: insert visual demonstrating the benchmark -->
2023-05-26 21:05:58 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
📦 [`agbenchmark`](https://pypi.org/project/agbenchmark/) on Pypi
&ensp;|&ensp;
📘 [Learn More](https://github.com/Significant-Gravitas/AutoGPT/blob/master/benchmark) about the Benchmark
2023-09-07 21:26:16 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
### 💻 UI
2023-03-24 04:51:51 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
**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.
2023-03-24 04:51:51 +00:00
<!-- TODO: insert screenshot of front end -->
2023-03-24 04:51:51 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
The frontend works out-of-the-box with all agents in the repo. Just use the [CLI] to run your agent of choice!
2023-03-24 04:51:51 +00:00
📘 [Learn More](https://github.com/Significant-Gravitas/AutoGPT/tree/master/classic/frontend) about the Frontend
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
### ⌨️ CLI
[CLI]: #-cli
2023-03-24 04:51:51 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
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:
2023-03-24 04:51:51 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
```shell
$ ./run
Usage: cli.py [OPTIONS] COMMAND [ARGS]...
2023-03-24 04:51:51 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
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)
2023-10-03 18:32:11 +00:00
[![Join us on Discord](https://invidget.switchblade.xyz/autogpt)](https://discord.gg/autogpt)
2023-03-24 04:51:51 +00:00
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 hasnt created an issue for the same topic.
2023-03-24 04:51:51 +00:00
docs: Streamline documentation for getting started (#6335) * README.md - Mark evo.ninja as hackathon winner and new Current Best Agent. - Remove hackathon banner. - Rewrite sections about Forge, Benchmark, UI, Agent Protocol. - Add sections about Leaderboard and CLI. - Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide. - Remove Quickstart. * docs.agpt.co - Removed links to outdated pages from navbar. - Added quick links to several pages. - Refactored and updated titles in docs site navbar for better readability and consistency. - Rewrite intros on homepage to be more clear and professional and less cringe-worthy. - Fix broken links. - Rewrote setup and usage guides for AutoGPT Agent. - Removed mentions of Azure support, except in the Docker guide. - Added page with general information about AutoGPT. * CONTRIBUTING.md - Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs. * autogpt/README.md - Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4. - Add quick links for improved user navigation, including links to documentation and contributing guidelines. - Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development. - Update links: documentation, setup instructions. - Remove outdated Twitter accounts section.
2023-11-23 13:59:17 +00:00
## 🤝 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.
---
2023-04-12 08:05:16 +00:00
<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>
2023-04-12 08:05:16 +00:00
</p>