AIOS Docs
  • Welcome
  • Getting Started
    • Installation
    • Quickstart
      • Use Terminal
      • Use WebUI
    • Environment Variables Configuration
  • AIOS Kernel
    • Overview
    • LLM Core(s)
      • LiteLLM Compatible Backend
      • vLLM Backend
      • Hugging Face Backend
      • LLM Routing
    • Scheduler
      • FIFOScheduler
      • RRScheduler
    • Context
    • Memory
      • Base Layer
      • Agentic Memory Operations
    • Storage
      • sto_mount
      • sto_create_file
      • sto_create_directory
      • sto_write
      • sto_retrieve
      • sto_rollback
      • sto_share
    • Tools
    • Access
    • Syscalls
    • Terminal
  • AIOS Agent
    • How to Use Agent
    • How to Develop Agents
      • Develop with Native SDK
      • Develop with AutoGen
      • Develop with Open-Interpreter
      • Develop with MetaGPT
    • How to Publish Agents
  • AIOS-Agent SDK
    • Overview
    • LLM Core API
      • llm_chat
      • llm_chat_with_json_output
      • llm_chat_with_tool_call_output
      • llm_call_tool
      • llm_operate_file
    • Memory API
      • create_memory
      • get_memory
      • update_memory
      • delete_memory
      • search_memories
      • create_agentic_memory
    • Storage API
      • mount
      • create_file
      • create_dir
      • write_file
      • retrieve_file
      • rollback_file
      • share_file
    • Tool API
      • How to Develop Tools
    • Access API
    • Post API
    • Agent API
  • Community
    • How to Contribute
Powered by GitBook
On this page
  • Prerequisites
  • Installation
  1. Getting Started

Installation

PreviousWelcomeNextQuickstart

Last updated 2 months ago

Prerequisites

  • Python: 3.10-3.11

  • Git

Installation

Installation from source

Step 1: Install AIOS Kernel

Git clone AIOS kernel

git clone https://github.com/agiresearch/AIOS.git

Create venv environment

python3.x -m venv venv # Only support for Python 3.10 and 3.11
source venv/bin/activate

or create conda environment

conda create -n venv python=3.x  # Only support for Python 3.10 and 3.11
conda activate venv

We strongly recommend using for faster and more reliable package installation.

To install uv:

pip install uv

For GPU environments:

uv pip install -r requirements-cuda.txt

For CPU-only environments:

uv pip install -r requirements.txt

Alternatively, if you prefer using pip:

For GPU environments:

pip install -r requirements-cuda.txt

For CPU-only environments:

pip install -r requirements.txt

Step 2: Install AIOS SDK (Cerebrum)

  1. Clone the Cerebrum repository:

    git clone https://github.com/agiresearch/Cerebrum.git
  2. Install using uv (recommended):

    cd Cerebrum && uv pip install -e .

    Or using pip:

    cd Cerebrum && pip install -e .

Note: The machine where the AIOS kernel (AIOS) is installed must also have the AIOS SDK (Cerebrum) installed. Installing AIOS kernel will install the AIOS SDK automatically by default. If you are using the Local Kernel mode, i.e., you are running AIOS and agents on the same machine, then simply install both AIOS and Cerebrum on that machine. If you are using Remote Kernel mode, i.e., running AIOS on Machine 1 and running agents on Machine 2 and the agents remotely interact with the kernel, then you need to install both AIOS kernel and AIOS SDK on Machine 1, and install the AIOS SDK alone on Machine 2.

Then you can follow the instructions in the to launch AIOS.

uv
Quickstart