Skip to content
Get packs

Guide · Open source

How to use OpenMAIC: clone, build and generate a lesson

Updated · written with AI from the project's own documentation and checked against our catalogue data

OpenMAIC (Open Multi-Agent Interactive Classroom) is an MIT-licensed, TypeScript platform that turns a topic or uploaded materials into a lesson with slides, quizzes, interactive simulations and project-based activities, delivered by AI teachers and AI classmates. This guide is for students, educators and developers who want to try it. By the end you will know how to get the code, what the README says about server setup, and what to expect when you generate a classroom.

OpenMAICTHU-MAIC/OpenMAIC · ★ 42.5k · MIT

Quick start

  1. 1Clone the repository. Run the git clone command for https://github.com/THU-MAIC/OpenMAIC.git on your machine.
  2. 2Read the setup docs. Open the docs under packages/docs and check the deployment page for server and PostgreSQL requirements.
  3. 3Configure models. Set up your models in openmaic.yml as described in the deployment docs.
  4. 4Start the server. Run the app as a long-running server, since generation runs on the server.
  5. 5Describe a topic. Enter a topic or attach your materials so the AI can build the lesson.
  6. 6Review the classroom. Switch to Edit to check slides, quizzes and simulations before sharing.

What OpenMAIC does

You give OpenMAIC a topic or attach your own documents. It generates a classroom made of scenes such as slides, quizzes, interactive HTML simulations and project-based learning (PBL) activities.

The lesson is presented by AI teachers and AI classmates who can speak, draw on a whiteboard and discuss with you.

  • Slides, quizzes, interactive HTML simulations and PBL activities
  • AI teachers and AI classmates that speak and draw on a whiteboard
  • Agents can draw diagrams and write formulas on the whiteboard
  • Text-to-speech (TTS) for spoken lessons

Get the OpenMAIC code

The README's install method is clone-and-build. Clone the repository with the command below, then follow the setup documentation in the repo. The README lists no separate prerequisites, but it does describe a server setup for some features.

The project's docs live in the repository under packages/docs, including a getting-started page and a deployment page.

git clone https://github.com/THU-MAIC/OpenMAIC.git

Understand the server and PostgreSQL requirement

OpenMAIC is not a one-command install. The README says some features need PostgreSQL and a long-running server. Generation runs on the server and survives closed tabs and restarts, according to the v1.2.0 notes.

Models are configured once in openmaic.yml, which the README says supports defaults, locks and an option to forbid user keys. Check the deployment docs before you start.

  • Some features require PostgreSQL
  • Classroom export (PPTX or offline HTML) needs PostgreSQL and a long-running server
  • Vercel deployments stay on version 1.1.x according to the README
  • Read the upgrade notes in the changelog before upgrading

Generate your first classroom

Describe a topic or attach your materials. The README says the AI builds a full lesson, and the highlights describe this as taking minutes. Materials are parsed as soon as they are attached in the server-first setup.

The v1.3.0 notes say uploads stay in your knowledge base until deleted, and you can reference them in the composer with @. Classroom tabs switch between Learn and Edit.

  • Type a topic, or attach a PDF or other document
  • Reference uploaded materials with @ in the composer
  • Switch between Learn and Edit tabs to review or change the lesson
  • Export as PPTX or as one offline HTML file if your setup supports it

Use the lesson as a student or educator

Students can follow the lesson and ask questions in classroom chat. The v1.1.0 notes say you can ask about any slide element, an interactive, or a whiteboard drawing.

Educators should review the output themselves. The README does not make claims about lesson accuracy, so treat generated content as a draft.

What people use it for

  • A student who wants a guided lesson on a topic they choose
  • An educator exploring AI-generated classroom material
  • A developer studying multi-agent orchestration applied to teaching
  • Turning your own documents into an interactive lesson

Frequently asked questions

Is OpenMAIC free?

OpenMAIC is released under the MIT licence, according to the README. The source does not list prices for any hosted service, so check the live demo and docs for current access.

What are the requirements for OpenMAIC?

The README lists no prerequisites for the clone-and-build method. Some features need PostgreSQL and a long-running server, so plan for that before you start.

Can I install OpenMAIC with one command?

No. The README describes a server setup and says some features need PostgreSQL, so it is not a simple one-command install.

Can I deploy OpenMAIC on Vercel?

Vercel deployments stay on version 1.1.x according to the README. Newer features need a long-running server with PostgreSQL.

Are the generated lessons accurate?

The README does not make claims about lesson accuracy, and it is not a verified or curriculum-accredited course. Review the content before relying on it.

Are there alternatives to OpenMAIC?

The source lists no comparable projects, so this guide cannot compare it with others. Evaluate options against your own needs.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

OpenMAIC suits people who want a guided, AI-generated lesson on their own topic or documents, and developers curious about multi-agent teaching. It is a clone-and-build server project rather than a quick install, and it is not a substitute for a verified course. If you need a one-command setup or accredited material, pick something else.

Install options & downloads