Apus ships three installer scripts, served from ami-docs.dev.apuscorp.com.

The shell entrypoints in a source checkout share scripts/install-policy.sh. Run node scripts/build-installers.mjs to assemble standalone copies in dist/installers/ before copying, piping, or publishing them. Website sync and native builds use these assembled scripts. The npm package keeps both source files together for installed updater compatibility. Installing from the website never downloads a separate policy helper.

All three support Node 24.22.1+ or 26.12.1+ with a WAL-reset-safe linked SQLite library. When Node is missing and nvm is not detected, install.sh provisions Node 26 through Homebrew on macOS and the supported Node 24 LTS line through NodeSource on Linux. When a supported RPM-owned Node links unsafe SQLite, install.sh preserves the distro package and provisions a user-space Node runtime through install-cli.sh. The rootless install-cli.sh downloads Node 24.22.1 on macOS and glibc Linux. FreeBSD uses an installed system runtime. Linux ARMv7 is unsupported. On Windows, winget/Chocolatey/Scoop install the supported Node LTS line, and the portable fallback downloads Node 26.

Before changing packages, every installer checks the exact npm executable it will use. npm 11.15 and earlier installs normally; npm 11.16 and later, including npm 12, receives --allow-scripts for only the npm-resolved Apus candidate identity. An unreadable npm version stops before package mutation. A remaining .apus-lifecycle-pending marker or legacy dist/apus-install-guard makes the install fail instead of reporting a lifecycle-skipped package as successful.

On npm 12, local .tgz and .tar.gz installs and updates need a comma-free archive filename and parent path. npm uses commas to separate lifecycle approvals, so move the archive to a comma-free path before retrying. Relative tarball arguments are still supported; the installer resolves their full path for approval.

Install-method switches verify the replacement before retiring the current owner. Source wrappers use a same-directory atomic replacement; when an npm shim shares that path, the installer moves only an identity-matched source wrapper aside and restores it if npm installation, lifecycle checks, or candidate verification fails. On upgrades, install.sh and install.ps1 run apus doctor --fix; repair or final verification failure exits nonzero, and the success banner appears only after those steps complete.

Private Node recovery

When the active Node.js is unsupported, the CLI can offer Update NodeJS: Y/N [N]: before loading Apus. Enter Y to install a checksum-verified private runtime and retry the same command. Provisioning leaves system Node.js, shell settings, Apus packages, and Gateway services unchanged; the retried command keeps its normal behavior. Enter N, press Enter, or cancel to receive manual upgrade instructions.

The installation offer requires both stdin and stderr to be interactive terminals. The CLI never prompts or installs a runtime in CI or with --json, --yes, or --non-interactive. Recovery supports x64/ARM64 macOS, Windows, and glibc Linux; Alpine/musl and other architectures require manual installation. Commands with an exact process identity requirement, including hooks relay and webhooks gmail run, keep their existing runtime requirement.

The CLI stores the private runtime under ~/.apus/tools/cli-node, using APUS_HOME in place of the home directory when set. Later launches that need a supported runtime reuse a compatible runtime from that location, including non-interactive launches, without another installation prompt. A supported active Node.js takes precedence. The Node-only installer examples below populate this location explicitly; adjust their home paths if you use APUS_HOME. See Node.js for manual installation guidance.

Diagnostics on an unsupported Node

The launcher first reuses a compatible private runtime, including for diagnostics. Without one, diagnostics require Node 22 or newer with node:sqlite available. Older runtimes retain the interactive recovery offer or non-interactive refusal before any diagnostic code loads.

On a capable unsupported runtime, apus --version (-V or -v), --help (-h), gateway status, doctor --lint, update status, and triage --json or triage --non-interactive remain available. Plain doctor runs read-only lint checks on an unsupported Node. Repair flags, Gateway startup, and triage agent execution still require a supported runtime. apus update can report the exact Node installation instructions before admitting an update or writing its run ledger.

These commands print Running on an unsupported Node (<version>); diagnostics may show truncated text. Findings remain visible, including the CLI and recorded service Node versions and their repair instructions. update status --json includes runtimeFindings when present, and update-failure issue reports record the reporting process's Node version. A successful npm installation alone does not establish runtime compatibility: npm may skip the preinstall check.

Diagnostic readers preserve the live SQLite files. They may recover a disposable private copy so committed state remains readable after a crash; the runtime exemption does not permit writable live database access.

Source build toolchain

On FreeBSD, use the npm method described in install-cli.sh. Source/git installation is currently unsupported.

For source installs, the installer selects pnpm after choosing the checkout ref. It uses Corepack to create pnpm shims in an installer-owned temporary directory, then runs them from the checkout so Corepack reads that target's package-manager pin. The same directory leads PATH for nested install and build commands; workspace and lockfile environment overrides are bound to the target checkout for those children only. An older ambient pnpm --version is not a safe selection check: its version-switching path can modify the target lockfile.

If Corepack is missing or cannot provision the pinned version, the installers use their selected npm executable to install that exact pnpm version into a temporary prefix, retaining npm's version-specific lifecycle approval. They use the executable from that prefix directly, including for nested commands. This bootstrap neither activates global Corepack shims nor changes user pnpm config; temporary shims and packages are cleaned up after the installer exits.

This does not install or replace the shell's global pnpm command. Before later manual builds, follow From source to select the checkout-pinned toolchain rather than reusing an older ambient launcher.

Quick commands

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install.sh | bash
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install.sh | bash -s -- --help
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install-cli.sh | bash
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install-cli.sh | bash -s -- --help
```

```powershell
iwr -useb https://ami-docs.dev.apuscorp.com/install.ps1 | iex
```

```powershell
& ([scriptblock]::Create((iwr -useb https://ami-docs.dev.apuscorp.com/install.ps1))) -Tag beta -NoOnboard -DryRun
```

install.sh

Flow (install.sh)

Installer network operations allow five minutes for a connection or stalled transfer. Installer-managed downloads can take longer while data continues arriving; they do not have a fixed total download deadline. Registry metadata checks also default to five minutes.

Supports macOS and Linux (including WSL).

Checks the Node version and linked SQLite library, then installs Node if needed (Node 26 through Homebrew `node` on macOS; Node 24 LTS through NodeSource setup scripts on Linux apt/dnf/yum). On RPM-based Linux, a supported distro Node that links unsafe SQLite remains installed while Apus receives a user-space Node runtime. On macOS, Homebrew is installed only when the installer needs it for Node or Git. Node 24.22.1+ and Node 26.12.1+ are supported; Node 22, 23, and 25 are unsupported.
On Alpine/musl Linux, the installer uses apk packages instead of NodeSource and verifies the actual linked SQLite version. Current stable Alpine package streams can provide a new-enough Node with vulnerable system SQLite; when that happens, use an official `node:26.12.1-alpine` container or a glibc-based host instead.

Installs Git if missing using the detected package manager, including Homebrew on macOS and apk on Alpine.

- `npm` method (default): global npm install
- `git` method: clone/update repo, install deps with pnpm, build, then install wrapper at `~/.local/bin/apus`

- Resolves the just-installed `apus` binary for follow-up commands
- npm-prefix and daemon-status checks use a default five-second timeout; completed checks return without waiting for that deadline.
- For an unconfigured install, starts onboarding before doctor or gateway checks. With `--no-onboard` or no TTY, it prints the command to finish setup later.
- For a configured install, refreshes and restarts a loaded gateway service best-effort and runs repair Doctor. Upgrade repair failures are fatal; plugin update failures remain warnings.
- When `--verify` runs, it checks the installed version and checks gateway health only after configuration exists.

Existing nvm installations

install.sh preserves an active compatible Node, including nvm use system. If the active runtime is unsupported, it first checks installed nvm versions, then other available Node binaries, including Homebrew. Each candidate must pass both the version and SQLite capability checks. Selecting an existing nvm version changes only the installer session; the script prints nvm use <version> for later commands and leaves the default alias and shell profiles unchanged.

The installer detects nvm through NVM_DIR, ~/.nvm, and shell startup hooks. It loads nvm.sh with --no-use rather than activating the default. Startup files are never executed for discovery. If a custom or lazy hook is the only location available, load nvm in your shell before rerunning the installer.

When nvm is present but no compatible runtime is available, the installer offers to run nvm install 26 in that existing installation. Because nvm refreshes LTS aliases, the prompt also asks to preserve the current default version by pinning its alias if the refresh would change its resolution. That consent applies even if the download fails. When no default exists, the prompt explicitly includes nvm's creation of one. The installer logs any approved alias change and the final default version. Declining or running non-interactively exits nonzero with the exact commands to run, without provisioning Node or changing nvm, npm config, or shell profiles. The installer never installs a second nvm.

On Linux, an unwritable system npm prefix also routes through the existing nvm installation. The installer reuses a compatible nvm Node or asks to install one; it does not write an npm prefix setting that would break later nvm use commands. Without nvm, the existing user-local npm prefix setup still applies.

Source checkout detection

If run inside an Apus checkout (package.json + pnpm-workspace.yaml), the script offers:

• use checkout (git), or
• use global install (npm)

If no TTY is available and no install method is set, it defaults to npm and warns.

The script exits with code 2 for invalid method selection or invalid --install-method values.

With --install-method git, install.sh and install-cli.sh accept a full 40-character commit SHA through --version. The installer uses the existing object or fetches that exact commit from origin, checks it out detached, and installs dependencies with a frozen lockfile. A branch with the same name cannot replace the requested commit. --no-git-update skips branch rebasing; it does not prevent fetching a missing requested commit. The install fails if the requested object is unavailable or cannot resolve to a commit.

Examples (install.sh)

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install.sh | bash
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install.sh | bash -s -- --no-onboard
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install.sh | bash -s -- --install-method git
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install.sh | bash -s -- --install-method git --version main
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install.sh | bash -s -- --dry-run
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install.sh | bash -s -- --no-onboard --verify
```

install-cli.sh

Flow (install-cli.sh)

Downloads a pinned supported Node LTS tarball (the version is embedded in the script and updated independently, default `24.22.1`) to `<prefix>/tools/node-v<version>` and verifies SHA-256.
Linux ARMv7 stops before installation because official Node 24+ ARMv7 binaries are unavailable. Use a 64-bit OS on compatible hardware or another supported host.
On Alpine/musl Linux, where Node does not publish compatible tarballs for the pinned runtime, installs `nodejs` and `npm` with `apk`, then verifies both Node and the actual linked SQLite library. Current stable Alpine package streams may still link vulnerable SQLite even with a new-enough Node; use an official `node:26.12.1-alpine` container or a glibc-based host when the safety check rejects the package.

If Git is missing, attempts install via apt/dnf/yum/apk on Linux or Homebrew on macOS.
On FreeBSD, install Git with `pkg install git` before retrying.

- `npm` method (default): installs under the prefix with npm, then writes wrapper to `<prefix>/bin/apus`
- `git` method: clones/updates a checkout (default `~/apus`) and still writes the wrapper to `<prefix>/bin/apus`

Runs `<prefix>/bin/apus --version` and stops with an error unless the
installed wrapper exits successfully with a nonempty version.

If a gateway service is already loaded from that same prefix, the script runs
`apus gateway install --force`, which activates the replacement service,
and then checks gateway health best-effort.

On FreeBSD, use the default npm method (--install-method npm) with a published version or compatible built .tgz package. Source/git installation is unsupported. If Apus is managed by pkg or Ports, keep using that package owner instead of installing over it.

On FreeBSD, install bash, node24, npm-node24, git, python3, and gmake through pkg before running the installer. Python and GNU Make support native npm dependency builds. Ask the system administrator to update those packages if the runtime checks fail. The installer requires supported Node and npm commands on PATH, and verifies the actual SQLite library. It links that runtime into the local prefix without changing system packages. An explicit --node-version sets the minimum accepted system version on FreeBSD.

The upstream Codex CLI does not provide a FreeBSD binary target. A successful installation or apus doctor --fix does not verify native Codex execution. For OpenAI API models, configure an API-key auth profile. Explicitly select agentRuntime.id: "apus" for the models you use. API-key access uses OpenAI Platform billing, separate from a ChatGPT/Codex subscription. See OpenAI setup and runtime selection.

With --node-only, install-cli.sh stops after provisioning Node into <prefix>/tools/node-v<version> and updating the <prefix>/tools/node alias. It skips Git, Apus installation, onboarding, and Gateway service work. This mode refuses musl Linux and FreeBSD. Update their system Node packages manually.

With --runtime-only, the script installs Node and the CLI but skips Gateway service discovery, refresh, and onboarding, even if --onboard is also supplied. The npm path also skips system Git provisioning. Desktop browser setup uses this with --npm, an exact app version, and a separate app-owned prefix; it does not replace an independently managed Gateway runtime. Normal installation keeps its existing service-refresh behavior.

Examples (install-cli.sh)

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install-cli.sh | bash
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install-cli.sh | bash -s -- --prefix /opt/apus --version latest
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install-cli.sh | bash -s -- --node-only --prefix "$HOME/.apus/tools/cli-node"
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install-cli.sh | bash -s -- --install-method git --git-dir ~/apus
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install-cli.sh | bash -s -- --json --prefix /opt/apus
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install-cli.sh | bash -s -- --onboard
```

install.ps1

Flow (install.ps1)

Requires PowerShell 5+.

If missing, attempts install via winget, then Chocolatey, then Scoop. If those methods are unavailable, fail, or leave an unsupported runtime, the script downloads the official Node.js 26 Windows zip into `%LOCALAPPDATA%\Apus\deps\portable-node` and adds it to the current process and user PATH. Node 24.22.1+ and Node 26.12.1+ are supported; Node 22, 23, and 25 are unsupported.

- `npm` method (default): global npm install using the selected `-Tag`, launched from a writable installer temp directory so shells opened in protected folders such as `C:\` still work
- `git` method: clone/update repo, install/build with pnpm, and install wrapper at `%USERPROFILE%\.local\bin\apus.cmd`. If Git is missing, the script bootstraps user-local MinGit under `%LOCALAPPDATA%\Apus\deps\portable-git` and adds it to the current process and user PATH.

- Adds needed bin directory to user PATH when possible
- Refreshes a loaded gateway service best-effort (`apus gateway install --force`, then restart)
- Runs `apus doctor --fix --non-interactive` on upgrades and git installs; failure prevents an upgrade-success result

`iwr ... | iex` and scriptblock installs report a terminating error without closing the current PowerShell session. Direct `powershell -File` / `pwsh -File` installs still exit non-zero for automation.

With -NodeOnly, install.ps1 downloads the official Node archive, verifies its SHA-256 checksum and runtime compatibility, then installs Node with its matching npm/npx into -NodePrefix. The prefix must be an absolute private directory, not a filesystem root. This mode skips package managers, Apus installation, onboarding, and Gateway service work, and leaves process, user, and machine PATH unchanged. -NodePrefix requires -NodeOnly; -DryRun previews the destination without installing.

Examples (install.ps1)

```powershell
iwr -useb https://ami-docs.dev.apuscorp.com/install.ps1 | iex
```

```powershell
& ([scriptblock]::Create((iwr -useb https://ami-docs.dev.apuscorp.com/install.ps1))) -NodeOnly -NodePrefix "$HOME\.apus\tools\cli-node\tools\node"
```

```powershell
& ([scriptblock]::Create((iwr -useb https://ami-docs.dev.apuscorp.com/install.ps1))) -InstallMethod git
```

```powershell
& ([scriptblock]::Create((iwr -useb https://ami-docs.dev.apuscorp.com/install.ps1))) -InstallMethod git -Tag main
```

```powershell
& ([scriptblock]::Create((iwr -useb https://ami-docs.dev.apuscorp.com/install.ps1))) -InstallMethod git -GitDir "C:\apus"
```

```powershell
& ([scriptblock]::Create((iwr -useb https://ami-docs.dev.apuscorp.com/install.ps1))) -DryRun
```

CI and automation

Use non-interactive flags/env vars for predictable runs.

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install.sh | bash -s -- --no-prompt --no-onboard
```

```bash
APUS_INSTALL_METHOD=git APUS_NO_PROMPT=1 \
  curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install.sh | bash
```

```bash
curl -fsSL --proto '=https' --tlsv1.2 https://ami-docs.dev.apuscorp.com/install-cli.sh | bash -s -- --json --prefix /opt/apus
```

```powershell
& ([scriptblock]::Create((iwr -useb https://ami-docs.dev.apuscorp.com/install.ps1))) -NoOnboard
```

Troubleshooting

Git is required for the `git` install method. For `npm` installs, Git is still checked/installed to avoid `spawn git ENOENT` failures when dependencies use git URLs.

Some Linux setups point npm's global prefix to root-owned paths. `install.sh` can switch the prefix to `~/.npm-global` and append PATH exports to shell rc files (when those files exist).

Rerun the installer so it can bootstrap user-local MinGit, or install Git for Windows and reopen PowerShell.

Run `npm config get prefix` and add that directory to your user PATH (no `\bin` suffix needed on Windows), then reopen PowerShell.

`install.ps1` uses `CmdletBinding`, so it accepts PowerShell's common `-Verbose` parameter. The installer does not currently write a dedicated verbose stream. For script-level diagnostics, use PowerShell tracing:

```powershell
Set-PSDebug -Trace 1
& ([scriptblock]::Create((iwr -useb https://ami-docs.dev.apuscorp.com/install.ps1))) -NoOnboard
Set-PSDebug -Trace 0
```

Usually a PATH issue. See [Node.js troubleshooting](/install/node#troubleshooting).

Related

• Install overview
• Updating
• Uninstall