Skip to content

fix(cli): Install Homebrew completions from the formula - #1555

Open
sentry-junior[bot] wants to merge 1 commit into
mainfrom
fix/cli-homebrew-completions-skills
Open

sentry-junior[bot] wants to merge 1 commit into
mainfrom
fix/cli-homebrew-completions-skills

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Fixes #1545.

Homebrew runs post_install under a temporary HOME and deletes it afterwards. So the formula's sentry cli setup --method brew --no-modify-path wrote completions, agent skills, and install metadata into a directory that was thrown away.

Changes to the formula template in .craft.yml:

  • Completions: generated during install with generate_completions_from_executable(bin/"sentry", "cli", "completion"), which writes them to Homebrew's own bash/zsh/fish completion dirs. These persist, and brew uninstall removes them.
  • post_install removed: it never left anything behind. Removing it also gets rid of Homebrew's post_install deprecation warning.
  • Caveats added: they tell users to run sentry cli setup --no-modify-path --no-completions to install the agent skill, and to run it again after brew upgrade. sentry cli upgrade already reruns setup by itself.

The install-method record doesn't need a replacement: the CLI already detects Homebrew from the Cellar realpath before it reads stored info.

The docs (getting-started.mdx, agentic-usage.md, plugins/README.md) no longer say Homebrew installs agent skills automatically, and they now show the manual step.

This only reaches users with the next CLI release, when craft regenerates getsentry/homebrew-tools/Formula/sentry.rb.

Still a draft: the formula hasn't been tested with a real brew install on macOS.

via byk.

--

View Junior Session in Sentry

Homebrew runs post_install under a throwaway HOME, so the
`sentry cli setup` call there wrote completions, agent skills, and
install metadata into a temp dir that was deleted right after.

Generate completions into Homebrew's own completion dirs during
install, drop the no-op post_install, and add caveats telling users
to run `sentry cli setup` for agent skills. Update docs that claimed
Homebrew installs skills automatically.

Fixes #1545

Co-Authored-By: byk <burak.kaya@sentry.io>
@vercel

vercel Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-local Ready Ready Preview Oct 20, 2026 3:51pm UTC

Request Review

@sentry-junior sentry-junior Bot added the CLI Sentry CLI and CLI documentation label Oct 20, 2026
@BYK
BYK marked this pull request as ready for review October 20, 2026 16:39
@github-actions github-actions Bot added the risk: medium PR risk score: medium label Oct 20, 2026

This branch was successfully deployed

1 active deployment
Preview — d435b1db Deployed Oct 20, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLI Sentry CLI and CLI documentation risk: medium PR risk score: medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix(cli): Homebrew post-install writes setup into a throwaway HOME, so completions and agent skills are never installed

1 participant