From 33fadb4272c4a52a89186d6540e6ae61f80f7933 Mon Sep 17 00:00:00 2001 From: "Garen J. Torikian" Date: Sun, 26 Jul 2026 15:27:38 -0400 Subject: [PATCH 1/2] docs: add Homebrew install instructions to the README The Homebrew channel shipped in #196 and the tap formula is live, but the README's Installation section only covered GitHub Releases and npm. Co-Authored-By: Claude Fable 5 --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5af34078..98dc4f33 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,13 @@ WorkOS CLI for installing AuthKit integrations and managing WorkOS resources. The CLI is distributed as a standalone executable from GitHub Releases. It does not require Node.js, Bun, or an npm installation. The first agent-driven command (e.g. `workos install`) performs a one-time, checksum-verified download of the Claude agent runtime (~230 MB, cached under `~/.workos`). -macOS and Linux: +Homebrew (macOS and Linux): + +```bash +brew install workos/tap/workos +``` + +macOS and Linux (direct download): ```bash case "$(uname -m)" in From 694c296bf033653dc9e73eb858493368ffd212cf Mon Sep 17 00:00:00 2001 From: "Garen J. Torikian" Date: Sun, 26 Jul 2026 17:49:13 -0400 Subject: [PATCH 2/2] docs: point Windows readers at the npm install option --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 98dc4f33..8dfc8638 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ $arch = if ($env:PROCESSOR_ARCHITECTURE -eq 'ARM64') { 'arm64' } else { 'x64' } Invoke-WebRequest "https://github.com/workos/cli/releases/latest/download/workos-windows-$arch.exe" -OutFile workos.exe ``` -Move `workos.exe` to a directory on your `PATH`, then run `workos install`. +Move `workos.exe` to a directory on your `PATH`, then run `workos install`. (If you already have Node.js, the npm install below works on Windows too.) npm (thin launcher that installs the same prebuilt binary for your platform):