Skip to content

Getting Started

AIOS has two products with different owners and lifecycles:

ProductOwnershipRequired?Repository
Individual WorkspaceOne private git repo per personYes for workspace workflows; works offlineaios-workspace
Team BrainOne shared service per teamOptional; needed only for shared memory and team syncaios-team-brain

Set up my workspace

Create the private, local workspace you and your agents use every day. No Team Brain or invitation is required.

Individual workspace setup →

Join an existing team

Create or repair your own workspace, accept a Team Brain invitation, connect, and preview your first share.

Join a Team Brain →

Create a team

Deploy one Team Brain, establish the admin account, invite members, and let each person connect their own workspace.

Team admin setup →

Orient an agent

Give an agent the compact ecosystem map, source hierarchy, safety invariants, and verification commands.

Agent source map → · /llms.txt

The products do not share one runtime requirement:

  • Individual Workspace: Node 22, git, and a machine you control.
  • Team Brain: Node 20 or newer, Postgres, git, and a deployment target.

The workspace toolkit is installed per person; the Brain is deployed once per team.

Every workspace path below starts with the aios command existing on your machine. Install it either from npm:

Install only after the v2.1.0 Git tag and @aiosbrain/aios@2.1.0 npm version are published. A documentation preview does not mean the release is available.

npm install --global @aiosbrain/aios@2.1.0

…or from the pinned public release, which is the path Individual workspace setup recommends and walks through in full:

Install only after the v2.1.0 Git tag and @aiosbrain/aios@2.1.0 npm version are published. A documentation preview does not mean the release is available.

git clone --branch v2.1.0 --depth 1 https://github.com/aiosbrain/aios-workspace.git aios-workspace && test "$(git -C aios-workspace rev-parse HEAD)" = "b92173e7b5f4d7d5da615fe77c5a9fbe39873dd7"
cd aios-workspace
npm install

Both give you the same aios command. The two differ only in where the scaffold templates and validators live on disk, which matters for a couple of commands later on — the setup guide covers that.