> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fau.run/developer/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting started

> Reach first success locally — install the node package and run the demo without Gmail.

**Purpose:** prove the stack runs on your machine before you deploy a relay or build
clients.

**Audience:** engineers cloning this repository.

## Prerequisites

* Python 3.11+ recommended
* Git
* No Gmail required for the demo

## 1. Clone the repository

```bash theme={null}
git clone https://github.com/ranagwho/Federated-Agent-Use.git
cd Federated-Agent-Use
```

## 2. Install the node package

From the repo root:

```bash theme={null}
python3 -m venv .venv
.venv/bin/pip install -e node
```

## 3. Run the seeded demo

```bash theme={null}
export FAU_HOME=/tmp/fau-demo
.venv/bin/python -m fedagent.cli demo
```

**Expected:** a synthetic mailbox is seeded; a scripted assistant walks first contact →
approval → structured reads → a free-form question. No network required.

## 4. Verify

```bash theme={null}
export FAU_HOME=/tmp/fau-demo
.venv/bin/python -m fedagent.cli status
```

You should see node identity and demo store stats under `/tmp/fau-demo`.

## What you just ran

A **node** process with an in-memory/demo path — not a full Mac app install, not a
public relay registration.

## Next (pick one)

| Goal | Page |
| - | - |
| Real Mac install with Gmail | [Run a node](https://docs.fau.run/developer/developers/run-node.md) |
| Public rendezvous | [Run a relay](https://docs.fau.run/developer/developers/run-relay.md) |
| Menu bar packaging | [Build the macOS client](https://docs.fau.run/developer/developers/build-macos.md) |
| Phone app | [Build a mobile client](https://docs.fau.run/developer/developers/build-mobile.md) |
| Change code | [Extend the codebase](https://docs.fau.run/developer/developers/extend.md) |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.