Installation - OpenAnalyst CLI Docs

System Requirements

Requirement	Details
OS	macOS 12+, Linux (glibc 2.31+), Windows 10/11
Terminal	Any terminal with UTF-8 and 256-color support
Disk	~25 MB (single binary)
Runtime	Node.js 18+ for the npm wrapper; no Rust or Python required

Install

Run the install script:

curl -fsSL https://raw.githubusercontent.com/OpenAnalystInc/cli/main/install.sh | bash

This installs the npm wrapper globally and downloads the native engine on first run.

Tip

After installation, run openanalyst --version to verify.

Open PowerShell as Administrator:

irm https://raw.githubusercontent.com/OpenAnalystInc/cli/main/install.ps1 | iex

The openanalyst command is added to your user PATH automatically.

Upgrade repair

The installer repairs stale OpenAnalyst global shims before reinstalling, which fixes older Windows installs that fail with EEXIST: file already exists ... openanalyst.

Backend-only deployment:

npm install -g @openanalystinc/openanalyst-cli@latest
openanalyst --notui
openanalyst --serve 8080

Use this when you want the hosted session API on a server without launching the TUI.

Info

This is the recommended server deployment path when you want a hosted OpenAnalyst backend with no interactive TUI attached.

Verify Installation

# Check the version
openanalyst --version
                  # Output: OpenAnalyst CLI v2.0.40

# Check logged-in providers
openanalyst whoami

Default Launch Modes

openanalyst starts the full TUI by default. Use openanalyst --notui for backend-only CLI usage or openanalyst --serve to expose hosted HTTP session endpoints from a server.

Updating

Re-run the same install script to update to the latest version. Your configuration and sessions are preserved.

# macOS / Linux
curl -fsSL https://raw.githubusercontent.com/OpenAnalystInc/cli/main/install.sh | bash

# Windows
irm https://raw.githubusercontent.com/OpenAnalystInc/cli/main/install.ps1 | iex

Troubleshooting npm Installs

If npm reports EEXIST: file already exists ... openanalyst, an older global shim is blocking the new package. The install scripts above repair that automatically. For manual npm recovery, run:

npm uninstall -g @openanalyst/cli @openanalystinc/openanalyst-cli
npm install -g @openanalystinc/openanalyst-cli@latest

On Windows, close terminals running openanalyst before reinstalling. If npm reports EPERM, retry in an Administrator PowerShell.

Uninstalling

Remove the global package and optionally clean up config:

# Remove package
npm uninstall -g @openanalystinc/openanalyst-cli

# Remove config (optional)
rm -rf ~/.openanalyst