Skip to content

Latest commit

 

History

History
140 lines (80 loc) · 5.05 KB

README.md

File metadata and controls

140 lines (80 loc) · 5.05 KB

Superagent 🥷

Build, deploy, and manage LLM-powered agents Superagent.sh

GitHub Contributors GitHub Last Commit GitHub Issues GitHub Pull Requests Github License Discord


Superagent UI

🧐 What is this?

Superagent is a powerful tool that simplifies the configuration and deployment of LLM (Large Language Model) Agents to production. It provides a range of features and functionalities to make it easier for developers to build, manage and deploy AI agents to production including features such as built in memory and document retrieval via vector dbs, powerful tools, webhooks, cron jobs etc.

🥷 Superagent Cloud

If you are looking for a plug-n-play way getting started be sure to checkout Superagent.sh.

🔎 Documentation

Checkout the full documentation here.

🚧 Roadmap

You can follow the roadmap here

🛠️ Getting Started

Getting started

To get started with Superagent, follow these steps:

  1. Clone the Superagent repository into a public GitHub repository or fork it from https://github.com/homanp/Superagent/fork. If you plan to distribute the code, keep the source code public.

    git clone https://github.com/homanp/Superagent.git
  2. To run the script, simply execute it using:

    bash setup.sh
  3. See the setup instructions for the UI in the ui folder.

Deploy on Replit

Superagent has first grade support for running on Replit. You can use the official public Repl to get started.

🌎 Environment variables

To run this project, you will need to add the following environment variables to your .env file

Mandatory variables

DATABASE_URL - A database connection string (with pooling)

DATABASE_MIGRATION_URL - A database connection (without pooling), used when creating/applying migrations.

OPENAI_API_KEY - An OpenAI API key

JWT_SECRET - A secret key/string

VECTORSTORE - Change this if you plan on supporting other vector databases.

PINECONE_ENVIRONMENT - Pinecone environment (found in the pinecone dashboard)

PINECONE_API_KEY - Pinecone API key (found in the pinecone dashboard)

SUPERAGENT_TRACING - If you want to enable agent tracing

Optional variables

PSYCHIC_API_KEY - Psychic.dev API key

BING_SUBSCRIPTION_KEY - Bing Search subscription key (found in the Azure dashboard)

BING_SEARCH_URL - Bing Search url (found in the Azure dashboard)

WOLFRAM_ALPHA_APPID - Wolfram Alpha App ID (found in your Wolfram Alpha dashboard)

REPLICATE_API_TOKEN - Replicate API token (found in uour replicate dashboard)

If you plan on using other Language Models

ANTHROPIC_API_KEY

COHERE_API_KEY

HUGGINGFACEHUB_API_TOKEN

AZURE_API_KEY

AZURE_API_TYPE

AZURE_API_BASE

AZURE_API_VERSION

💡 Examples

  • Running Superagent with NextJS

👨🏽‍💻 SDKs

🫶 Contributions

Superagent is an open-source project, and contributions are welcome. If you would like to contribute, you can create new features, fix bugs, or improve the infrastructure. Please refer to the CONTRIBUTING.md file in the repository for more information on how to contribute.

We appreciate your contributions and aim to make it easy for anyone to create and run LLM Agents in production using Superagent.

⭐ Partners

A big thanks to all partners that support the development of Superagent!

🌿 Fern: Fern helps create SDKs and client libraries from OpenAPI specs. Superagent uses Fern for all of the client libraries and SDKs we provide. A big shout out for the support!

🙏 Support

We appreciate all the support you can give us, either with contributions, feedback, bug reports or feature requests. Drop a star and share Superagent to the world!