Skip to content

docs: add Homebrew installation option#406

Open
emaarco wants to merge 3 commits intogoogleworkspace:mainfrom
emaarco:docs/issue-339
Open

docs: add Homebrew installation option#406
emaarco wants to merge 3 commits intogoogleworkspace:mainfrom
emaarco:docs/issue-339

Conversation

@emaarco
Copy link

@emaarco emaarco commented Mar 11, 2026

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:

  • My code follows the AGENTS.md guidelines (no generated google-* crates).
  • I have run cargo fmt --all to format the code perfectly. — N/A (no Rust changes)
  • I have run cargo clippy -- -D warnings and resolved all warnings. — N/A (no Rust changes)
  • I have added tests that prove my fix is effective or that my feature works. — N/A (docs-only change)
  • I have provided a Changeset file (e.g. via pnpx changeset) to document my changes.

emaarco added 2 commits March 11, 2026 13:24
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-bot
Copy link

changeset-bot bot commented Mar 11, 2026

🦋 Changeset detected

Latest commit: 47b8829

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@googleworkspace/cli Patch

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

@google-cla
Copy link

google-cla bot commented Mar 11, 2026

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.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 README.md, it aims to streamline the setup process and enhance the user experience for macOS users who prefer using Homebrew for package management.

Highlights

Changelog
  • .changeset/add-homebrew-install-docs.md
    • Added a new changeset file to document the addition of Homebrew installation instructions.
  • .gitignore
    • Added .claude/settings.local.json to the ignore list.
  • README.md
    • Included instructions for installing the CLI via Homebrew on macOS.
Activity
  • The author created a new changeset file to document the changes.
  • The author confirmed adherence to AGENTS.md guidelines.
  • The author noted that Rust-related checks (formatting, clippy, tests) were not applicable as this is a documentation-only change.
  • The author confirmed providing a Changeset file.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Generative AI Prohibited Use Policy, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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.

…gnore

Moved the entry from the IDE section into a dedicated # AI agents block
for better organization and clarity.
@googleworkspace-bot
Copy link
Collaborator

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds documentation for installing the CLI via Homebrew on macOS and adds a local settings file path to the .gitignore file. The changes are straightforward and I did not find any issues that require attention.

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.

docs: add Homebrew as an installation option in README

2 participants