Skip to content

docs: add Homebrew install instructions to the README #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gjtorikian merged 2 commits into from
Jul 26, 2026
Merged

docs: add Homebrew install instructions to the README #210

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33fadb4
docs: add Homebrew install instructions to the README
gjtorikian Jul 26, 2026
694c296
docs: point Windows readers at the npm install option
gjtorikian Jul 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -34,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):

Expand Down
Loading