From c7d4c0bfed281719ed49e32069b9fdd2e3f135ec Mon Sep 17 00:00:00 2001 From: hongyi-chen Date: Thu, 13 Aug 2026 19:46:45 +0000 Subject: [PATCH] Document Homebrew install for the Warp Agent CLI Add a Homebrew tab to the Warp Agent CLI quickstart install step and split the "Automatic updates" section by install method. The `warp-agent-cli` cask is now in the main homebrew/cask repository (macOS 14+ and Linux), so `brew install --cask warp-agent-cli` works without tapping. Homebrew installs are deliberately documented as a secondary option: the client detects them and only *checks* for new versions, surfacing "update available - run brew upgrade --cask warp-agent-cli" instead of staging the update itself. The install script remains the recommended path because it is the only one that self-updates. Co-Authored-By: Warp Agent --- src/content/docs/agents/cli/index.mdx | 7 +++++-- src/content/docs/agents/cli/quickstart.mdx | 15 +++++++++++++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/src/content/docs/agents/cli/index.mdx b/src/content/docs/agents/cli/index.mdx index 3cb8bfaf..ac8af0d6 100644 --- a/src/content/docs/agents/cli/index.mdx +++ b/src/content/docs/agents/cli/index.mdx @@ -50,9 +50,12 @@ You sign in once, and the CLI stays signed in across sessions. ## Automatic updates -The CLI updates automatically. While it runs, it periodically checks for a newer version, downloads it in the background, and stages it without interrupting your session. The staged version takes effect the next time you launch `warp`. When an update is ready, the start screen shows an "update installed, restart to apply" notice next to the version. +How the CLI updates depends on how you installed it. -To turn off background updates, set `general.autoupdate_enabled` to `false` in the [settings file](/agents/cli/configuration/#the-settings-file). To turn them off for a single launch, set the `WARP_TUI_DISABLE_AUTOUPDATE` environment variable to any value. +* **Install script** - The CLI updates itself. While it runs, it periodically checks for a newer version, downloads it in the background, and stages it without interrupting your session. The staged version takes effect the next time you launch `warp`. When an update is ready, the start screen shows an "update installed, restart to apply" notice next to the version. +* **Homebrew** - Homebrew owns the installation, so the CLI never replaces it. It still checks for newer versions and shows an "update available" notice next to the version on the start screen. Install the update yourself by running `brew upgrade --cask warp-agent-cli`. + +To turn off update checks, set `general.autoupdate_enabled` to `false` in the [settings file](/agents/cli/configuration/#the-settings-file). To turn them off for a single launch, set the `WARP_TUI_DISABLE_AUTOUPDATE` environment variable to any value. ## Coming from the Warp app diff --git a/src/content/docs/agents/cli/quickstart.mdx b/src/content/docs/agents/cli/quickstart.mdx index 902d65f1..ac721795 100644 --- a/src/content/docs/agents/cli/quickstart.mdx +++ b/src/content/docs/agents/cli/quickstart.mdx @@ -16,7 +16,7 @@ This guide takes you from installing the {VARS.WARP_CLI} to your first agent con ## 1. Install the Warp Agent CLI -Install the CLI with the command for your operating system. +Install the CLI with the command for your operating system. The install script is the recommended method, because it's the only one that keeps the CLI up to date on its own. @@ -31,6 +31,17 @@ Install the CLI with the command for your operating system. Invoke-RestMethod "https://app.warp.dev/download/agent-cli.ps1" | Invoke-Expression ``` + + On macOS 14 or later and on Linux, install the `warp-agent-cli` cask. It's in the main Homebrew cask repository, so you don't need to tap anything first: + + ```bash + brew install --cask warp-agent-cli + ``` + + :::caution + Homebrew installations don't update themselves. The CLI still tells you when a new version is available, but you install it by running `brew upgrade --cask warp-agent-cli`. To get background updates instead, use the install script. See [automatic updates](/agents/cli/#automatic-updates). + ::: + After installing, verify that the `warp` command is available: @@ -39,7 +50,7 @@ After installing, verify that the `warp` command is available: warp --version ``` -The command prints the installed version. From here on, the CLI updates automatically. See [automatic updates](/agents/cli/#automatic-updates). +The command prints the installed version. If you used the install script, the CLI updates itself from here on. See [automatic updates](/agents/cli/#automatic-updates). ## 2. Log in