Skip to main content
Set up the Hyperbrowser CLI (hx) and/or the SDKs to start working with sandboxes. Latest release:
1

Install the CLI

Install the latest release with the official install script:
curl -fsSL https://www.hyperbrowser.ai/cli/install.sh | sh
In PowerShell, download and extract the latest Windows build:
$version = (Invoke-WebRequest -UseBasicParsing https://www.hyperbrowser.ai/cli/LATEST).Content.Trim()
$url = "https://www.hyperbrowser.ai/cli/hx_${version}_windows_amd64.tar.gz"
Invoke-WebRequest -UseBasicParsing $url -OutFile hx.tar.gz
tar -xzf hx.tar.gz
Move-Item .\hx.exe "$env:USERPROFILE\AppData\Local\Microsoft\WindowsApps\hx.exe"
For ARM64 Windows, replace windows_amd64 with windows_arm64.
curl -fsSL https://www.hyperbrowser.ai/cli/install.sh | sh -s -- --version <version>
Each release is published as a tarball at:
https://www.hyperbrowser.ai/cli/hx_<version>_<target>.tar.gz
PlatformTarget
Linuxlinux_amd64, linux_arm64
macOSdarwin_amd64, darwin_arm64
Windowswindows_amd64, windows_arm64
The snippet below resolves the current release and downloads the artifact that matches your platform:
version=$(curl -fsSL https://www.hyperbrowser.ai/cli/LATEST)
curl -fsSL "https://www.hyperbrowser.ai/cli/hx_${version}_darwin_arm64.tar.gz" -o hx.tar.gz
tar -xzf hx.tar.gz
Confirm the CLI is on your PATH:
hx version
2

Install the SDK

npm install @hyperbrowser/sdk

pip install hyperbrowser
# or
uv add hyperbrowser
3

Configure your API key

Grab your API key from the Hyperbrowser Dashboard.
Export as an environment variable:
export HYPERBROWSER_API_KEY=<your_api_key>

import { Hyperbrowser } from "@hyperbrowser/sdk";

const client = new Hyperbrowser({
  apiKey: process.env.HYPERBROWSER_API_KEY,
});
See Sandbox CLI for the full command reference, including named profiles and per-command overrides.