SuperAGI README

The project's README from github.com/TransformerOptimus/SuperAGI. As one markdown file: README.md.

SuperAGI logo SuperAGI logo

Open-source framework to build, manage and run useful Autonomous AI Agents

SuperAGI forks SuperAGI stars SuperAGI Commits

Follow SuperAGI

Follow _superAGI Join SuperAGI Discord Community

Connect with the Creator

Follow ishaanbhola

Share SuperAGI Repository

Follow _superAGI Share on Telegram Share on Reddit Buy Me A Coffee


What are we ?

A dev-first open source autonomous AI agent framework enabling developers to build, manage & run useful autonomous agents. You can run concurrent agents seamlessly, extend agent capabilities with tools. The agents efficiently perform a variety of tasks and continually improve their performance with each subsequent run.

💡 Features

🛠 Toolkits

Toolkits allow SuperAGI Agents to interact with external systems and third-party plugins.

Twitter Coding Tool Instagram Knowledge Search Email Jira File Manager Google Search Dall-E Github Web Interaction Duckduckgo Google Calendar Google Calendar Serp API Searx Web Scraper Notion Apollo

⚙️ Installation

You can install superAGI using one of the following three approaches.

☁️ SuperAGI cloud

To quickly start experimenting with agents without the hassle of setting up the system, try Superagi Cloud

  1. Visit Superagi Cloud and log in using your github account.

  2. In your account settings, go to "Model Providers" and add your API key.

You're all set! Start running your agents effortlessly.

🖥️ Local

  1. Open your terminal and clone the SuperAGI repository.
git clone https://github.com/TransformerOptimus/SuperAGI.git 
  1. Navigate to the cloned repository directory using the command:
cd SuperAGI
  1. Create a copy of config_template.yaml, and name it config.yaml.

  2. Ensure that Docker is installed on your system. You can download and install it from here.

  3. Once you have Docker Desktop running, run the following command in the SuperAGI directory:

    a. For regular usage:

    docker compose -f docker-compose.yaml up --build
    

    b. If you want to use SuperAGI with Local LLMs and have GPU, run the following command:

    docker compose -f docker-compose-gpu.yml up --build
    
  4. Open your web browser and navigate to http://localhost:3000 to access SuperAGI.

🌀 Digital Ocean


Deploy SuperAGI to DigitalOcean with one click.

🌐 Architecture

SuperAGI Architecture

SuperAGI Architecture

Agent Architecture

Agent Architecture

Agent Workflow Architecture

Agent Workflow Architecture

Tools Architecture

Tools Architecture

ER Diagram

ER Diagram

📚 Resources

📖 Need Help?

Join our Discord community for support and discussions.

Join us on Discord

If you have questions or encounter issues, please don't hesitate to create a new issue to get support.

💻 Contribution

We ❤️ our contributors. We’re committed to fostering an open, welcoming, and safe environment in the community.

If you'd like to contribute, start by reading our Contribution Guide.

We expect everyone participating in the community to abide by our Code of Conduct.

To get more idea on where we are heading, checkout our roadmap here.

Explore some good first issues to start contributing.

👩‍💻 Contributors

TransformerOptimus Cptsnowcrasher vectorcrow Akki-jain Autocop-AgentCOLONAYUSHluciferlinx101mukundans89Fluder-ParadynenborthynihirrTarraannneelayan7Arkajit-Dattaguangchen811juanfpo96iskandarrezajpenalbaepallasite99xutpuualexkreidlerhanhyalex123ps4vseltociear shaiss AdityaRajSingh1992 namansleeps2 sirajperson hsm207 unkn-wn DMTarmey Parth2506 platinaCoder anisha1607 jorgectf [![PaulRBerg](https://ima

SuperAGI (TransformerOptimus/SuperAGI)

Searching Database…

17.7K ·GitHub
What is this?SuperAGI is a dev-first open source framework for building, managing and running autonomous AI agents — agents that perform tasks and improve with each run.
Is it a framework I code against, or a product I just run?It is a Python framework, but it ships with its own graphical interface: after setup you manage and interact with your agents in the browser and extend them via toolkits.
How do I get it running?Easiest: log into SuperAGI Cloud with your GitHub account and add an API key under Model Providers. Locally: clone the repo, copy configtemplate.yaml to config.yaml, start Docker and run the compose command, then open the web UI.
What do I need to have installed before starting?Docker must be installed for the local setup, and you need an LLM API key added in the Model Providers settings. The hosted SuperAGI Cloud option skips Docker entirely — just a GitHub login and your key.
What are toolkits?Toolkits let SuperAGI agents interact with external systems and third-party plugins; you add them from the marketplace to your agent workflows.
Do agents remember previous runs?Yes — agent memory storage lets agents learn and adapt by storing their memory, and the project says agents continually improve their performance with each subsequent run.
How do I keep API costs under control?There is optimized token usage — you control token usage to manage costs effectively — plus performance telemetry that shows how your agents are doing so you can optimize.
Can I run several agents at once?Yes — you can provision, spawn and deploy autonomous agents and run concurrent agents seamlessly, with production-ready and scalable agents as the stated goal.
What are similar projects?ruflo, Raven, hive, brigade, DB-GPT, AgentGPT, bareloop, awesome-ai-agents
Size
62 MB
Stars
17.7K
Age
3y
Commits · 90 Days