> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bugster.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Installation
> Install Bugster CLI and start AI-powered end-to-end testing
Bugster CLI generates and runs AI-powered end-to-end tests for web applications.
## Requirements
Required for browser automation
Required for Linux distributions
**Operating Systems**:
* macOS (compatible)
* Linux: Ubuntu 22+, Ubuntu 24+, Debian 12+, and any distribution with GLIBC ≥ 2.35
* Windows (compatible)
} color="#green">
Pages and App Router supported.
React Router DOM v6/v7 supported.
All major Vue configurations supported.
All major Angular configurations supported.
All major Svelte configurations supported.
All major JavaScript frameworks supported.
**Framework behavior note**: Next.js and React have enhanced features for the `generate` and `update` commands. Other frameworks use standard implementation.
View detailed framework support and routing compatibility information
}>
Vercel deployments compatible.
}>
Netlify deployments compatible.
## Installation
### Installation
Install Bugster CLI using Homebrew on macOS or Linux:
```bash theme={null}
brew install Bugsterapp/homebrew-tap/bugster
```
### Updating
To update Bugster to the latest version:
```bash theme={null}
brew upgrade bugster
```
### Installation
Install Bugster CLI globally using npm:
```bash theme={null}
npm install -g @bugster/bugster-cli
```
**Note**: You need Node.js 18+ installed. Verify your Node.js version with `node --version`.
### Updating
To update Bugster to the latest version:
```bash theme={null}
npm update -g @bugster/bugster-cli
```
### Automated Installation
Install Bugster CLI using the automated installer script on macOS or Linux:
```bash theme={null}
curl -sSL https://bugster.dev/install.sh | bash
```
### Reset your terminal session
After installation, make sure to reset your terminal so PATH changes take effect. You can either close and reopen your terminal, or run:
```bash theme={null}
source ~/.zshrc # zsh
source ~/.bashrc # bash
```
### Recommended Method
The recommended way to install Bugster CLI on Windows is by using the PowerShell installer. Open a PowerShell terminal and run the following command:
```powershell theme={null}
irm https://bugster.dev/install.ps1 | iex
```
This command downloads and executes the official installer script, which will:
1. Determine the correct version for your system.
2. Download the binary from the latest GitHub Release.
3. Unzip and place it in a standard user directory (`%LOCALAPPDATA%\Programs\bugster`).
4. Add the installation directory to your user's `PATH` environment variable.
After installation, you must **open a new terminal window** for the `bugster` command to be available.
### Manual Installation
If you prefer not to run the script, you can install the CLI manually:
Go to the [latest GitHub Release](https://github.com/Bugsterapp/bugster-cli/releases/latest).
Download the `bugster-windows.zip` file.
Extract the `bugster.exe` file to a directory of your choice (e.g., `C:\Program Files\bugster`).
Manually add that directory to your system's or user's `PATH` environment variable.
### Verify Installation
```bash theme={null}
bugster --version
```
## Troubleshooting
```bash theme={null}
node --version
# Should show v18.0.0 or higher
```
```bash theme={null}
ldd --version
# Should show GLIBC 2.35 or higher
```
**Symptom:** Installation fails with permission errors, even when using `sudo`.
**Cause:** The `~/.local` directory may have been created by another process with root ownership, preventing your user from writing to `~/.local/bin`.
**Solution:**
```bash theme={null}
ls -ld ~/.local ~/.local/bin
```
If the owner is `root` instead of your username, proceed to the next step.
```bash theme={null}
sudo chown -R $(whoami) ~/.local
```
Run the installer again **without** sudo:
```bash theme={null}
curl -sSL https://bugster.dev/install.sh | bash
```
**Alternative solution:** Install directly to `/usr/local/bin`:
```bash theme={null}
# Download the binary manually first, then:
sudo cp bugster /usr/local/bin/
```
If you encounter compatibility issues on Linux, ensure your distribution has GLIBC 2.35 or higher. Supported distributions include Ubuntu 22+, Ubuntu 24+, Debian 12+, and other modern distributions.
**Symptom:** After running the installer, `bugster.exe` is not found in the installation directory (`%LOCALAPPDATA%\Programs\bugster`), or it disappears shortly after installation.
**Cause:** Because the executable is downloaded from the internet and is not digitally signed by a major publisher, Windows Defender or other antivirus software may automatically quarantine or delete it as a security precaution.
**Solution:**
1. Open **Windows Security** > **Virus & threat protection**.
2. Go to **Protection history** to see if `bugster.exe` was quarantined. If so, you can restore it and allow it on your device.
To prevent this from happening in the future, add an exclusion:
* Under **Virus & threat protection settings**, click **Manage settings**.
* Scroll down to **Exclusions** and click **Add or remove exclusions**.
* Click **Add an exclusion**, select **Folder**, and paste the following path: `%LOCALAPPDATA%\Programs\bugster`
**Symptom:** After a successful installation, you type `bugster --help` and get an error like `'bugster' is not recognized...`.
**Cause:** The terminal session where you ran the installer has an old copy of the `PATH` variable. The changes made by the installer will only be loaded by new terminal sessions.
**Solution:**
Close your current terminal window and **open a new one**. The command should now work correctly.
**What gets installed**: Bugster CLI, Playwright browsers, and all required dependencies are installed automatically. Python is no longer required for Bugster versions > 0.3.26.
Follow our quickstart guide to set up your first project