Installation

Unreach can be installed globally or run directly with npx without installation.

Run with npx (Recommended)

No installation required! Run Unreach directly:

npx unreach@latest scan

This is the recommended approach as it always uses the latest version.

Install Globally

With npm

npm install -g unreach

With bun

bun install -g unreach

With yarn

yarn global add unreach

With pnpm

pnpm add -g unreach

After global installation, you can run unreach from anywhere:

unreach scan

Check for Updates

Unreach can automatically detect your package manager and show the correct update command:

unreach check-update

The command will:

• Check the npm registry for the latest version
• Show an update notification if a newer version is available
• Display the correct install command based on your package manager

Unreach automatically detects your package manager by checking:

1. Lock files (package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lock)
2. Environment variables
3. Defaults to npm if none detected

Verify Installation

Check that Unreach is installed correctly:

unreach --version

You should see the version number printed.

Next Steps

Once installed, check out the Getting Started guide to run your first scan.