---
title: "Installation"
description: "Install the PgBeam CLI with npm, Homebrew, or the install script, on macOS, Linux, or Windows."
canonical: "https://pgbeam.com/docs/cli"
last-updated: "2026-09-14T19:37:21.000Z"
---

# Installation

> Install the PgBeam CLI with npm, Homebrew, or the install script, on macOS, Linux, or Windows.

URL: https://pgbeam.com/docs/cli

The PgBeam CLI is open source at sferarc/pgbeam-cli.

The install script below works today. The npm package `@pgbeam/cli` and the
Homebrew tap `sferarc/pgbeam` are documented here as what they will be, and
neither installs anything until the first release publishes them. Use the
install script, or the Windows script, until then.

Pick whichever fits how you already install tools. They all give you the same `pgbeam` command.

Not published yet, so this command does not work today. It is what the npm
install will be.

Runs on Node 20.19 or newer. To use it once without installing:

The tap is not populated yet, so this command does not work today. It is
what the Homebrew install will be.

Installs a self-contained native binary, so no Node runtime is needed. macOS and Linux, on both Apple silicon or ARM64 and x86\_64.

Upgrade with `brew upgrade pgbeam`.

Downloads the same native binary as Homebrew and puts it on your PATH. macOS and Linux, x86\_64 and ARM64.

Once `@pgbeam/cli` is published, npm will work the same on Windows: `npm install -g @pgbeam/cli`.

Verify the installation:

After installing, authenticate with your PgBeam account:

See auth login for details.

## Keeping it up to date

How you upgrade depends on how you installed:

Installed with

Upgrade with

npm

`npm install -g @pgbeam/cli@latest`

Homebrew

`brew upgrade pgbeam`

Install script

`pgbeam update`

`pgbeam update` replaces the native binary in place, so use it for an install-script install. On a Homebrew or npm install, let the package manager do it instead, or its bookkeeping and the binary on disk will disagree.