Skip to content

Document Homebrew install for the Warp Agent CLI #524

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

Open
hongyi-chen wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document Homebrew install for the Warp Agent CLI #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7d4c0b
Document Homebrew install for the Warp Agent CLI
hongyi-chen Aug 13, 2026
8e0f74e
Merge branch 'main' into docs/agent-cli-homebrew-install
hongyi-chen Aug 14, 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
7 changes: 5 additions & 2 deletions src/content/docs/agents/cli/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
15 changes: 13 additions & 2 deletions src/content/docs/agents/cli/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Tabs>
<TabItem label="macOS and Linux">
Expand All @@ -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
```
</TabItem>
<TabItem label="Homebrew">
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).
:::
</TabItem>
</Tabs>

After installing, verify that the `warp` command is available:
Expand All @@ -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

Expand Down
Loading