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

# Install

# Install

Already followed [Getting Started](https://docs.wednesdayai.dev/next/users/start/getting-started.md)? You're all set — this page is for alternative install methods, platform-specific instructions, and maintenance.

## System requirements

* **[Node 24+](https://docs.wednesdayai.dev/next/admin/install/node.md)** (the [installer script](#install-methods) will install it if missing)
* macOS, Linux, or Windows
* `pnpm` only if you build from source

> [!NOTE]
>
> On Windows, we strongly recommend running WednesdayAI under [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).

## Install methods

> [!TIP]
>
> The **installer script** is the recommended way to install WednesdayAI. It handles Node detection, installation, and onboarding in one step.

> [!WARNING]
>
> For VPS/cloud hosts, avoid third-party "1-click" marketplace images when possible. Prefer a clean base OS image (for example Ubuntu LTS), then install WednesdayAI yourself with the installer script.

> [accordion] Installer script
>
> Downloads the CLI, installs it globally via npm, and launches the onboarding wizard.
>
> > [tab] macOS / Linux / WSL2
> >
> > ```bash theme={"dark"}
> > curl -fsSL https://wednesdayai.dev/install.sh | bash
> > ```
>
> > [tab] Windows (PowerShell)
> >
> > ```powershell theme={"dark"}
> > iwr -useb https://wednesdayai.dev/install.ps1 | iex
> > ```
>
> That's it — the script handles Node detection, installation, and onboarding.
>
> To skip onboarding and just install the binary:
>
> > [tab] macOS / Linux / WSL2
> >
> > ```bash theme={"dark"}
> > curl -fsSL https://wednesdayai.dev/install.sh | bash -s -- --no-onboard
> > ```
>
> > [tab] Windows (PowerShell)
> >
> > ```powershell theme={"dark"}
> > & ([scriptblock]::Create((iwr -useb https://wednesdayai.dev/install.ps1))) -NoOnboard
> > ```
>
> For all flags, env vars, and CI/automation options, see [Installer internals](https://docs.wednesdayai.dev/next/admin/install/installer.md).
>
> The hosted installers are served from the published npm tarball. The canonical origin is the
> pinned, versioned CDN path:
>
> > [tab] macOS / Linux / WSL2
> >
> > ```bash theme={"dark"}
> > curl -fsSL https://unpkg.com/wednesdayai@<version>/scripts/install.sh | bash -s -- --version <version>
> > ```
>
> > [tab] Windows (PowerShell)
> >
> > ```powershell theme={"dark"}
> > & ([scriptblock]::Create((iwr -useb https://unpkg.com/wednesdayai@<version>/scripts/install.ps1))) -Tag <version>
> > ```
>
> The URL pins the installer script; `--version` / `-Tag` pins the `wednesdayai` package it installs
> (both default to `latest`).
>
> `https://unpkg.com/wednesdayai@latest/scripts/install.sh` is an optional moving alias that
> always resolves to the newest release; the hosted `install.sh` URL follows it.

> [accordion] npm / pnpm
>
> If you already have Node 24+ and prefer to manage the install yourself:
>
> > [tab] npm
> >
> > ```bash theme={"dark"}
> > npm install -g wednesdayai@latest --allow-scripts=node-llama-cpp,@google/genai,protobufjs,koffi
> > wednesdayai onboard --install-daemon
> > ```
> >
> > > [accordion] npm install-scripts warnings?
> > >
> > > npm 11.16+ warns when install scripts run without an allowlist, and npm 12 blocks them
> > > outright. `--allow-scripts=<list>` names exactly the packages whose install scripts we
> > > trust; with the list shown above the install is warning-free on npm 12 (tested with
> > > `npx npm@12 install -g`).
> > >
> > > * npm ≤ 11.15: no allowlist mechanism — omit the flag.
> > > * npm 11.16: install works, but prints a warning unless the flag is present.
> > > * npm 12: install scripts are blocked unless the flag is present.
> > > * `npm approve-scripts` only works for project installs; it has no effect on global
> > >   installs.
> >
> > > [accordion] sharp build errors?
> > >
> > > If you have libvips installed globally (common on macOS via Homebrew) and `sharp` fails, force prebuilt binaries:
> > >
> > > ```bash theme={"dark"}
> > > SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install -g wednesdayai@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 env var above.
>
> > [tab] pnpm
> >
> > ```bash theme={"dark"}
> > pnpm add -g wednesdayai@latest
> > pnpm approve-builds -g        # approve openclaw, node-llama-cpp, sharp, etc.
> > wednesdayai onboard --install-daemon
> > ```
> >
> > > [!NOTE]
> > >
> > > pnpm requires explicit approval for packages with build scripts. After the first install shows the "Ignored build scripts" warning, run `pnpm approve-builds -g` and select the listed packages.

> [accordion] From source
>
> For contributors or anyone who wants to run from a local checkout.
>
> **1. Clone and build**
>
> Clone the [WednesdayAI repo](https://github.com/ExpansionX/WednesdayAI-core) and build:
>
> ```bash theme={"dark"}
> git clone https://github.com/ExpansionX/WednesdayAI-core.git
> cd WednesdayAI-core
> pnpm install
> pnpm build
> pnpm control:build:packaged
> ```
>
> **2. Install the CLI from a tarball**
>
> Build a local npm tarball and install that copy globally:
>
> ```bash theme={"dark"}
> npm pack
> npm install -g ./wednesdayai-*.tgz --allow-scripts=node-llama-cpp,@google/genai,protobufjs,koffi
> rm ./wednesdayai-*.tgz
> ```
>
> The package exposes both `wednesdayai` and the compatibility `openclaw` command.
>
> **3. Run onboarding**
>
> ```bash theme={"dark"}
> wednesdayai onboard --install-daemon
> ```
>
> For deeper development workflows, see [Setup](https://docs.wednesdayai.dev/next/users/start/setup.md).

## Other install methods

> [card] [Docker](https://docs.wednesdayai.dev/next/admin/install/docker.md)
>
> Containerized or headless deployments.

> [card] [Podman](https://docs.wednesdayai.dev/next/admin/install/podman.md)
>
> Rootless container: run `setup-podman.sh` once, then the launch script.

> [card] [Nix](https://docs.wednesdayai.dev/next/admin/install/nix.md)
>
> Declarative install via Nix.

> [card] [Ansible](https://docs.wednesdayai.dev/next/admin/install/ansible.md)
>
> Automated fleet provisioning.

## After install

Verify everything is working:

```bash theme={"dark"}
wednesdayai doctor         # check for config issues
wednesdayai status         # gateway status
wednesdayai dashboard      # open the browser UI
```

If you need custom runtime paths, use:

* `OPENCLAW_HOME` for home-directory based internal paths
* `OPENCLAW_STATE_DIR` for mutable state location
* `OPENCLAW_CONFIG_PATH` for config file location

See [Environment vars](https://docs.wednesdayai.dev/next/users/help/environment.md) for precedence and full details.

## Troubleshooting: `openclaw` not found

> [accordion] PATH diagnosis and fix
>
> Quick diagnosis:
>
> ```bash theme={"dark"}
> node -v
> npm -v
> npm prefix -g
> echo "$PATH"
> ```
>
> If `$(npm prefix -g)/bin` (macOS/Linux) or `$(npm prefix -g)` (Windows) is **not** in your `$PATH`, your shell can't find global npm binaries (including `wednesdayai` and the compatibility `openclaw` command).
>
> Fix — add it to your shell startup file (`~/.zshrc` or `~/.bashrc`):
>
> ```bash theme={"dark"}
> 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

> [card] [Updating](https://docs.wednesdayai.dev/next/admin/install/updating.md)
>
> Keep WednesdayAI up to date.

> [card] [Migrating](https://docs.wednesdayai.dev/next/admin/install/migrating.md)
>
> Move to a new machine.

> [card] [Uninstall](https://docs.wednesdayai.dev/next/admin/install/uninstall.md)
>
> Remove WednesdayAI completely.


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