Skip to content

docs: prefer pipx/uv over Homebrew for CLI install (Guardian)#2711

Open
milanwilliams wants to merge 1 commit into
mainfrom
milan/intellij-guardian-brew-best-effort
Open

docs: prefer pipx/uv over Homebrew for CLI install (Guardian)#2711
milanwilliams wants to merge 1 commit into
mainfrom
milan/intellij-guardian-brew-best-effort

Conversation

@milanwilliams

@milanwilliams milanwilliams commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Marks Homebrew as a best-effort install method and prefers pipx/uv for installing the Semgrep CLI in the Guardian docs, matching the framing already used in docs/getting-started/quickstart.mdx and the IntelliJ extension prerequisites.

  • docs/guardian.mdx — in "Install the Semgrep CLI", reordered the intro sentence to "pipx, uv, or Homebrew" (kept the Python 3.10 note) and the install block to lead with pipx/uv, demoted Homebrew to best-effort (macOS), and added a NOTE callout.

The IntelliJ extension page was originally part of this change but is now covered by #2692 (merged), so this PR is Guardian-only.

Thanks for improving Semgrep Docs

Please ensure:

  • A subject matter expert reviews the content
  • A technical writer reviews the PR
  • This change has no security implications or else you have pinged the security team — docs-only change, no security implications
  • Any redirects are in docs/docs.json if URLs changed — no URLs changed, no redirects needed
  • If you edited docs/extensions/pre-commit.md.template.mdx, CI regenerates pre-commit.mdx on this PR — n/a
  • Check the Mintlify bot preview link on this PR (requires PR to main)

🤖 Generated with Claude Code

@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
semgrep-docs 🟢 Ready View Preview Jul 16, 2026, 2:16 AM

@milanwilliams
milanwilliams force-pushed the milan/intellij-guardian-brew-best-effort branch from ed17e14 to 1e0a001 Compare July 16, 2026 22:37
@milanwilliams milanwilliams changed the title docs: prefer pipx/uv over Homebrew for CLI install (IntelliJ + Guardian) docs: prefer pipx/uv over Homebrew for CLI install (Guardian) Jul 16, 2026
Mark Homebrew as a best-effort install method and prefer pipx/uv in the
Guardian "Install the Semgrep CLI" section, matching the framing in the
getting-started quickstart and the IntelliJ extension prerequisites.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant