README.md

Superagent 🥷

The open framework for building AI Assistants

---

Superagent is an open-source agent framework that enables any developer to integrate production-ready AI Assistants into any application in a matter of minutes.

---

🎥 Demo

demo.mp4

🧐 Tutorials

We post tutorials regularly on our YouTube channel. Make sure to check them out !

✨ Use cases

Superagent lets you build any AI application/microservice you want, including:

• Question/Answering over Documents (LLM Finetunes/Vectorstores).
• Chatbots.
• Co-pilots & AI assistants.
• Content generation.
• Data aggregation.
• Workflow automation.

👀 Features:

• Memory
• Streaming
• Custom finetuning 🆕
• Python/Typescript SDKs
• REST API
• API connectivity
• Vectorization
• Support for proprietary and OSS LLMs
• API concurrency support

📋 Documentation:

For full documentation, visit docs.superagent.sh

To see how to contribute, visit Contribution guidelines

☁️ Run on Replit:

1. Create a Replit REPL by importing the Superagent Github Repository. Link

2. Set the REPL language to Python

3. Replace the contents of the .replit file in your REPL with the following

   run = "chmod 777 ./libs/superagent/replit.sh && cd ./libs/superagent && ./replit.sh"
   modules = ["python-3.10:v18-20230807-322e88b", "nodejs-18:v3-20230608-f4cd419"]
   
   hidden = [".pythonlibs"]
   
   [nix]
   channel = "stable-23_05"
   
   [deployment]
   run = ["sh", "-c", "chmod 777 ./libs/superagent/replit.sh && cd ./libs/superagent && ./replit.sh"]
   deploymentTarget = "cloudrun"

4. Add all necessary .env variables as Replit Secrets. Also, add the following additional secret:

   TZ = Etc/UTC

5. Deploy the REPL using Replit Autoscale.

🛠️ Run locally:

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.

Both the API and UI require a database in order to work. We recommend setting this up on Supabase.

Setting up Supabase

Create a Supabase account and project. We have separated the UI and API into two separate Supabase projects, which is recommended since the app runs on prisma.

Supabase setup for Superagent UI project:

1. Run the migrations (checkout Superagent UI section for this)

   supabase migration up (locally)
   supabase db push (cloud)

2. Run the following query to setup authentication:

   -- inserts a row into public.profiles
   create function public.handle_new_user()
   returns trigger
   language plpgsql
   security definer set search_path = public
   as $$
   begin
   insert into public.profiles (user_id)
   values (new.id);
   return new;
   end;
   $$;
   
   -- trigger the function every time a user is created,
   create trigger on_auth_user_created
   after insert on auth.users
   for each row execute procedure public.handle_new_user();

3. Create a Supabase storage

4. Set storage permissions: Set the following policy for storage.objects

Setting up Github OAuth in UI

1. Create a new Github OAuth app in your Github account

2. Copy the CLIENT_ID and CLIENT_SECRET and paste them into the .env variables in the Superagent UI project.

3. Set the following callback URL

   <YOUR_SUPABASE_URL>/auth/v1/callback

4. Navigate to your Supabase project you have created for Superagent UI and paste the CLIENT_ID and CLIENT_SECRET

NOTE: You can enable any provider using the steps above.

Superagent API

1. Navigate to /libs/superagent

2. Rename the env.example to .env and make sure you have all mandatory values set

3. Create a virtual environment

   virtualenv venv
   source venv/bin/activate

4. Install dependencies

   poetry install

5. Run database migrations

   poetry run prisma migrate dev

6. Start the server

   uvicorn app.main:app --reload

Superagent UI

1. Navigate to /libs/ui

2. Rename the env.example to .env and make sure you have all mandatory values set

3. Install the dependencies:

   npm install

4. Run migrations:

   supabase migrate up (local)
   supabase db push (cloud)

5. Run the development server

   npm run dev
   

Superagent legacy

Please refer to the README in /libs/legacy for further instructions.

Run locally with docker and docker compose

In the .docker folder, there are multiple docker-compose files.

The main docker-compose.yml file will start the API and a Postgres-DB in docker.

The other docker-compose files can be used individually or in combination to start up the necessary bits.

follow the guide in .docker/README.md file to get started

🔗 SDKs

If you are planning to integrate Superagent into your stack, you can use one of the following SDKs:

• Python
• Typescript/Javascript
• Swift (Community)

🫶 Contributions:

Superagent is an open-source project, and contributions are welcome. If you want 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.