Skip to content

Document Homebrew install for the Warp Agent CLI - #524

Open
hongyi-chen wants to merge 1 commit into
mainfrom
docs/agent-cli-homebrew-install
Open

Document Homebrew install for the Warp Agent CLI#524
hongyi-chen wants to merge 1 commit into
mainfrom
docs/agent-cli-homebrew-install

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

What

Documents brew install --cask warp-agent-cli as a secondary install method for the Warp Agent CLI, and clarifies that auto-update behavior differs by install method.

  • agents/cli/quickstart.mdx — adds a Homebrew tab (third, after macOS/Linux and Windows) with a :::caution that Homebrew installs don't self-update.
  • agents/cli/index.mdx — splits Automatic updates into two bullets: install script (self-updating) vs. Homebrew (check-only, brew upgrade --cask warp-agent-cli).

Why

The warp-agent-cli cask is now in the main homebrew/cask repository (macOS 14+ and Linux, autobump: true), so brew install --cask warp-agent-cli works with no tap. It was undocumented.

It's documented as secondary on purpose. The client already treats Homebrew installs differently — crates/warp_tui/src/autoupdate.rs detects a Caskroom path and takes the AutoupdateEligibility::Homebrew branch, which only checks for new versions and surfaces:

update available — run brew upgrade --cask warp-agent-cli

Native install-script installs get real background staging. So the docs now match the shipped behavior rather than the previous blanket claim that "the CLI updates automatically."

Competitive precedent

Every peer that ships a brew cask keeps it out of the primary install path:

  • Claude Code — marketing page shows only curl … | bash; Homebrew is tab 2 of 3 in docs with an explicit "Homebrew installations do not auto-update" callout.
  • Codexnpm i -g @openai/codex on openai.com/codex; Homebrew is tab 4 of 4 in the developer docs.
  • Cursor CLI — has a cursor-cli cask in brew core but doesn't mention brew on the marketing site or in its install docs.
  • Amp — curl/PowerShell first, Homebrew under "Other Installation Methods".

Validation

  • npm run build — 364 pages built, no errors.
  • python3 .agents/skills/style_lint/style_lint.py --changed — no new issues beyond a pre-existing-style UNRECOGNIZED-TERM warning for the bolded **Homebrew** list term, which matches the existing **Linux** / **Windows** warnings in the same file.

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 <agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Aug 13, 2026
@vercel

vercel Bot commented Aug 13, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 13, 2026 7:52pm

Request Review

Copy link
Copy Markdown
Collaborator Author

This PR was generated with Warp.

View run View conversation

@hongyi-chen
hongyi-chen marked this pull request as ready for review August 13, 2026 19:55
@oz-for-oss

oz-for-oss Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

@hongyi-chen

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@oz-for-oss oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR documents Homebrew as a secondary installation method for the Warp Agent CLI and updates the automatic-update guidance to distinguish install-script self-updates from Homebrew-managed upgrades. The changed MDX follows the docs structure and the new commands, links, and callout are scoped to the edited pages.

Concerns

  • None.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@hongyi-chen
hongyi-chen enabled auto-merge (squash) August 13, 2026 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant