Skip to content
Get packs

Guide · Open source

How to use AIRI: install and get started

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

AIRI is an open-source project that aims to recreate a Neuro-sama style AI virtual character, a companion you run on your own machine. This guide shows you how to install it on Windows or macOS, where to find the official documentation, and what the project does and does not confirm. By the end you will know which install route to pick and what to check next.

AIRImoeru-ai/airi · ★ 51k · MIT

Quick start

  1. 1Pick your platform. Choose Windows, macOS or the web, based on what you have. Windows and macOS have package manager routes; the web option is linked from the official site.
  2. 2Install on Windows. Run winget install MoeruAI.AIRI in a terminal. Scoop is an alternative route listed in the README.
  3. 3Install on macOS. Run brew install --cask airi in Terminal. Homebrew must be installed first.
  4. 4Or download the app. Use the Windows, macOS or Linux download buttons in the README to get the build from the GitHub releases page.
  5. 5Read the official docs. Open airi.moeru.ai/docs/ for setup and configuration details that the README excerpt does not cover.
  6. 6Ask the community. If you get stuck, the README links to a Discord server where you can ask questions.

What AIRI is and what it does

AIRI describes itself as a self-hosted, you-owned AI companion, a container for AI virtual characters meant to bring them into your world. The project says it supports realtime voice chat and can play games such as Minecraft and Factorio.

It runs on the web, macOS and Windows, and its code is written in TypeScript under the MIT licence.

  • Realtime voice chat with an AI character
  • Game playing described for Minecraft and Factorio
  • Web, macOS and Windows support
  • Open source under the MIT licence

Install AIRI on Windows with winget

If you use Windows, the README lists winget as an install route. Open a terminal and run the command below. The README also mentions Scoop as an alternative on Windows, using the bucket and install commands it lists.

winget install MoeruAI.AIRI

Install AIRI on macOS with Homebrew Cask

On macOS, the README says you can install AIRI with Homebrew Cask without adding a custom tap. Make sure Homebrew is installed first, then run the command below in Terminal.

brew install --cask airi

Download AIRI from the release pages or the website

The README shows download buttons for Windows, macOS and Linux that link to the project's GitHub releases. It also links to a browser option and a mobile option on the official site, airi.moeru.ai, which you can open from the Try it link.

Pick the file that matches your system. If you are unsure which build is right for you, read the official docs before downloading.

  • Windows: setup file from the GitHub releases page
  • macOS: disk image from the GitHub releases page
  • Linux: link to the latest GitHub release
  • Browser and mobile: options on airi.moeru.ai

Read the docs and ask for help

The README points to the official documentation at airi.moeru.ai/docs/. For detailed setup and configuration, start there, since the README excerpt does not include the full setup walkthrough.

The README also links to a Discord server, and to a DeepWiki page for the repository. A dedicated GitHub organisation, proj-airi, hosts related sub-projects such as RAG, memory and Live2D utilities.

  • Official docs: airi.moeru.ai/docs/
  • Discord: linked from the README
  • DeepWiki page for the repository
  • Related sub-projects: github.com/proj-airi

Know the limits before you start

The README excerpt does not describe the project's stability or maturity, so treat it as something to try rather than a production tool. It also does not list prerequisites for installation.

The README states clearly that the project has no officially minted cryptocurrency or token. Be cautious of anyone claiming otherwise.

  • Maturity and stability are not described in the README
  • No install prerequisites are listed in the excerpt
  • No official cryptocurrency or token exists, according to the README

What people use it for

  • Running a self-hosted AI virtual character instead of using a hosted service
  • Holding realtime voice conversations with an AI character
  • Experimenting with a VTuber-style character and its avatar
  • Trying AI play in games such as Minecraft and Factorio, as the project describes

Frequently asked questions

Is AIRI free to use?

The README states that AIRI is released under the MIT licence. The excerpt does not list prices, so the licence is the only cost-related detail confirmed here.

How do I install AIRI on Windows?

The README lists winget as an install route on Windows. Run winget install MoeruAI.AIRI in a terminal. Scoop is also listed as an alternative in the README.

How do I install AIRI on a Mac?

The README says you can install AIRI on macOS with Homebrew Cask without adding a custom tap. Run brew install --cask airi in Terminal.

Does AIRI have a token or cryptocurrency?

No. The README explicitly states that the project has no officially minted cryptocurrency or token associated with it. Be cautious of any claim that says otherwise.

What are the alternatives to AIRI?

The item's comparable projects include Open-LLM-VTuber, SillyTavern and Amica, which are AIRI-like VTuber frameworks. Pick based on whether you want a realtime voice character or a more general chat front end.

Does AIRI have system requirements or prerequisites?

The README excerpt does not list prerequisites. Check the official docs at airi.moeru.ai/docs/ for setup details before you install.

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

AIRI suits people who want to self-host an AI virtual character, enjoy VTuber-style characters, or want to build a realtime voice companion and are happy to read docs and tinker. It is less suitable if you need a stable, production-grade tool or a plug-and-play experience, since the README does not confirm maturity and the excerpt has no simple setup walkthrough.

Install options & downloads