docs: add Homebrew installation option#406
docs: add Homebrew installation option#406emaarco wants to merge 3 commits intogoogleworkspace:mainfrom
Conversation
Add documentation for installing the CLI via Homebrew on macOS, alongside existing installation methods. Include changeset entry and local Claude settings configuration.
Prevent local Claude Code settings from being accidentally committed.
🦋 Changeset detectedLatest commit: 47b8829 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates the project's documentation to include Homebrew as a recognized installation method. By adding clear instructions to the Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds Homebrew as an installation option to the README.md and includes a corresponding changeset. My review includes one suggestion for the .gitignore file to ignore the entire .claude/ directory for better maintainability and to prevent potential future issues with sensitive file commits, which is consistent with how other tool directories are handled in the project.
Note: Security Review has been skipped due to the limited scope of the PR.
.gitignore
Outdated
| # IDE | ||
| .idea/ | ||
| .vscode/ | ||
| .claude/settings.local.json |
There was a problem hiding this comment.
For consistency with other tool-specific ignores like .idea/ and .vscode/, it's better to ignore the entire .claude/ directory. This will prevent other files from this directory, which may contain local or sensitive information, from being accidentally committed in the future.
.claude/
There was a problem hiding this comment.
I've tracked it intentionally just partially — since in a prior commit (chore: steps to reduce contributor friction) a settings.json was added.
-
Ignoring the entire directory would cause that shared config to be excluded for future contributors (if removed at some point).
-
Still, the
settings.localshould be excluded, as that's the developer-local override that could inadvertently affect which tool calls are permitted for another dev's agent.
Thus, i've moved it to an AI-Agent section
…gnore Moved the entry from the IDE section into a dedicated # AI agents block for better organization and clarity.
|
/gemini review |
2 participants
Description
Adds Homebrew as an explicit installation option in the README, alongside npm, pre-built binaries, Cargo, and Nix. A formula already exists in homebrew-core; this just makes it discoverable for macOS users.
Closes #399
Dry Run Output:
N/A — documentation-only change.
Checklist:
AGENTS.mdguidelines (no generatedgoogle-*crates).cargo fmt --allto format the code perfectly. — N/A (no Rust changes)cargo clippy -- -D warningsand resolved all warnings. — N/A (no Rust changes)pnpx changeset) to document my changes.