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

# Install

# Install

Use the installer unless you have a reason not to. It sets up the CLI and runs onboarding.

## Quick install (recommended)

```bash theme={null}
curl -fsSL https://equabot.com/install.sh | bash
```

Windows (PowerShell):

```powershell theme={null}
iwr -useb https://equabot.com/install.ps1 | iex
```

Next step (if you skipped onboarding):

```bash theme={null}
equabot onboard --install-daemon
```

## System requirements

* **Node >=22**
* macOS, Linux, or Windows via WSL2
* `pnpm` only if you build from source

## Choose your install path

### 1) Installer script (recommended)

Installs `equabot` globally via npm and runs onboarding.

```bash theme={null}
curl -fsSL https://equabot.com/install.sh | bash
```

Installer flags:

```bash theme={null}
curl -fsSL https://equabot.com/install.sh | bash -s -- --help
```

Details: [Installer internals](/install/installer).

Non-interactive (skip onboarding):

```bash theme={null}
curl -fsSL https://equabot.com/install.sh | bash -s -- --no-onboard
```

### 2) Global install (manual)

If you already have Node:

```bash theme={null}
npm install -g equabot@latest
```

If you have libvips installed globally (common on macOS via Homebrew) and `sharp` fails to install, force prebuilt binaries:

```bash theme={null}
SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install -g equabot@latest
```

If you see `sharp: Please add node-gyp to your dependencies`, either install build tooling (macOS: Xcode CLT + `npm install -g node-gyp`) or use the `SHARP_IGNORE_GLOBAL_LIBVIPS=1` workaround above to skip the native build.

Or:

```bash theme={null}
pnpm add -g equabot@latest
```

Then:

```bash theme={null}
equabot onboard --install-daemon
```

### 3) From source (contributors/dev)

```bash theme={null}
git clone https://github.com/equabot/equabot.git
cd equabot
pnpm install
pnpm ui:build # auto-installs UI deps on first run
pnpm build
equabot onboard --install-daemon
```

Tip: if you don’t have a global install yet, run repo commands via `pnpm equabot ...`.

### 4) Other install options

* Docker: [Docker](/install/docker)
* Nix: [Nix](/install/nix)
* Ansible: [Ansible](/install/ansible)
* Bun (CLI only): [Bun](/install/bun)

## After install

* Run onboarding: `equabot onboard --install-daemon`
* Quick check: `equabot doctor`
* Check gateway health: `equabot status` + `equabot health`
* Open the dashboard: `equabot dashboard`

## Install method: npm vs git (installer)

The installer supports two methods:

* `npm` (default): `npm install -g equabot@latest`
* `git`: clone/build from GitHub and run from a source checkout

### CLI flags

```bash theme={null}
# Explicit npm
curl -fsSL https://equabot.com/install.sh | bash -s -- --install-method npm

# Install from GitHub (source checkout)
curl -fsSL https://equabot.com/install.sh | bash -s -- --install-method git
```

Common flags:

* `--install-method npm|git`
* `--git-dir <path>` (default: `~/equabot`)
* `--no-git-update` (skip `git pull` when using an existing checkout)
* `--no-prompt` (disable prompts; required in CI/automation)
* `--dry-run` (print what would happen; make no changes)
* `--no-onboard` (skip onboarding)

### Environment variables

Equivalent env vars (useful for automation):

* `EQUABOT_INSTALL_METHOD=git|npm`
* `EQUABOT_GIT_DIR=...`
* `EQUABOT_GIT_UPDATE=0|1`
* `EQUABOT_NO_PROMPT=1`
* `EQUABOT_DRY_RUN=1`
* `EQUABOT_NO_ONBOARD=1`
* `SHARP_IGNORE_GLOBAL_LIBVIPS=0|1` (default: `1`; avoids `sharp` building against system libvips)

## Troubleshooting: `equabot` not found (PATH)

Quick diagnosis:

```bash theme={null}
node -v
npm -v
npm prefix -g
echo "$PATH"
```

If `$(npm prefix -g)/bin` (macOS/Linux) or `$(npm prefix -g)` (Windows) is **not** present inside `echo "$PATH"`, your shell can’t find global npm binaries (including `equabot`).

Fix: add it to your shell startup file (zsh: `~/.zshrc`, bash: `~/.bashrc`):

```bash theme={null}
# macOS / Linux
export PATH="$(npm prefix -g)/bin:$PATH"
```

On Windows, add the output of `npm prefix -g` to your PATH.

Then open a new terminal (or `rehash` in zsh / `hash -r` in bash).

## Update / uninstall

* Updates: [Updating](/install/updating)
* Uninstall: [Uninstall](/install/uninstall)