docs/installation.md · leegoobin/AIBuddy

# Installation

## macOS (Homebrew)

```bash
brew tap aibuddy-org/tap
brew install aibuddy
```

To install the latest development version from `main`:

```bash
brew install --HEAD aibuddy
```

After installing, initialize and start a project:

```bash
mkdir -p ~/my-agent && cd ~/my-agent
aibuddy-server --init
aibuddy-server
```

To update:

```bash
brew upgrade aibuddy
```

---

## Build from Source

**Requirements:** CMake 3.20+, C++17 compiler, Node.js 18+ (for web client).

### Linux / macOS / Windows

```bash
git clone https://github.com/aibuddy-org/aibuddy.git
cd aibuddy

make setup-web
make build-web
make build
make install
```

The `make install` command creates a symlink in `~/.local/bin`. Make sure it's in your `PATH`.

Then initialize and start a project:

```bash
aibuddy-server init /path/to/your/project
aibuddy-server start --project /path/to/your/project
```

### Build Targets

Run `make help` for a full list. Common targets:

| Command | Description |
|---|---|
| `make build` | Build server (release) |
| `make build-debug` | Build server (debug) |
| `make build-web` | Build web client |
| `make build-all` | Build everything (server + web + shared lib) |
| `make install` | Build and install to `~/.local/bin` |
| `make run` | Build and run server |

See [Build](build.md) for the complete reference.

---

## Docker

```bash
docker run -p 8080:8080 -v aibuddy-data:/data ghcr.io/aibuddy-org/aibuddy
```

Or build from source:

```bash
docker build -t aibuddy .
docker run -p 8080:8080 -v aibuddy-data:/data aibuddy
```

See [Docker](docker.md) for compose setup and configuration.

---

## One-Click Cloud Deploy

| Platform | |
|---|---|
| Render | [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/aibuddy-org/aibuddy) |
| Heroku | [![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://www.heroku.com/deploy?template=https://github.com/aibuddy-org/aibuddy) |
| DigitalOcean | [![Deploy to DigitalOcean](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/aibuddy-org/aibuddy/tree/main) |

See [Deploy](deploy.md) for detailed instructions per platform.

---

## Mobile

AIBuddy runs natively on iOS and Android via the Flutter app. See [Flutter](flutter.md) for build and release instructions.

leegoobin/AIBuddy

简介

发行版

贡献者

语言

近期动态

leegoobin/AIBuddy .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

语言

近期动态

搜索帮助

leegoobin/AIBuddy