Skip to content
AIOS

Quickstart

AIOS has two parts that you set up independently. Start with your individual workspace.

Part 1 — Your Workspace

Section titled “Part 1 — Your Workspace”

  1. Clone the workspace repo

    Terminal window
    git clone https://github.com/AIOS-alpha/aios-workspace
    cd aios-workspace
    npm install

  2. Pick your context and scaffold

    Are you a consultant working on an engagement, or an employee inside a company?

    Terminal window
    scripts/scaffold-project.sh \
      --context consultant \
      --slug acme-workspace \
      --stakeholder "Acme Corp" \
      --owner your-name \
      --team "you,colleague1,colleague2" \
      --org AIOS-alpha \
      --output ~/Projects/acme-workspace

  3. Open the scaffolded workspace

    Terminal window
    cd ~/Projects/acme-workspace   # or wherever you pointed --output

    You’ll find the numbered spine already in place:

    0-context/    scope and framing
    1-inbox/      raw inputs land here
    2-work/       deliverables live here
    3-log/        decisions, tasks, hours
    4-shared/     what goes to the client or company
    5-personal/   private scratch, never syncs

  4. Validate the structure

    Terminal window
    /path/to/aios-workspace/validation/validate-all.sh .

    All checks should pass on a fresh scaffold.

  5. Run a harness

    Try the weekly synthesis harness:

    Terminal window
    # Inside Claude Code, in your scaffolded workspace:
    /weekly-synthesis

Part 2 — Team Brain (optional, team setup)

Section titled “Part 2 — Team Brain (optional, team setup)”

  1. Clone the brain repo

    Terminal window
    git clone https://github.com/AIOS-alpha/aios-team-brain
    cd aios-team-brain
    npm install

  2. Start Supabase and seed demo data

    Terminal window
    supabase start
    cp .env.example .env.local
    # Fill in values from `supabase status -o env` + your Anthropic key
    npx tsx --conditions react-server scripts/seed-demo.ts
    npm run dev

  3. Copy the API key printed during seed

    The seed script prints a demo API key once:

    AIOS_API_KEY=aios_<key_id>_<secret>

  4. Wire up your workspace

    In your scaffolded workspace, edit aios.yaml:

    brain_url: http://localhost:3000   # or your deployed brain URL
    api_key: aios_<your-key>

  5. Push your first content

    Terminal window
    cd ~/Projects/acme-workspace
    aios status      # preview what would sync
    aios push        # send team-tier content to the brain

  6. Query the brain

    Terminal window
    aios query "what decisions did we make this week?"

Next steps

Section titled “Next steps”