Skip to content

Installation instructions do not cover Mac + Homebrew setup #60

@Microserf2005

Description

@Microserf2005

Environment

  • SDK version: latest
    • Python version: managed via Homebrew (e.g., brew install python)
      • OS / platform: macOS (Apple Silicon / x86_64)
        • Install method: Homebrew

Description

The installation instructions on the main README only show:

pip install google-antigravity

This assumes users have a system-level or pyenv-managed pip available globally. On macOS with Homebrew, the Python installation and package management work differently — for example, pip may not be in PATH, the correct command may be pip3 or python3 -m pip, and virtual environments may need to be created explicitly before installing packages (especially after PEP 668 changes that prevent installing packages into the system Python).

Steps to Reproduce

  1. Follow the README installation instructions on a Mac using Homebrew-managed Python
    1. Run pip install google-antigravity
    1. Encounter errors such as command not found: pip, or error: externally-managed-environment (PEP 668)

Expected Behavior

The installation instructions should include a Homebrew-specific section covering:

  • Using brew install python to install Python
    • Using pip3 or python3 -m pip instead of pip
      • Creating and activating a virtual environment first (python3 -m venv .venv && source .venv/bin/activate) to work around PEP 668 restrictions
        • Example commands:
        • brew install python
        • python3 -m venv .venv
        • source .venv/bin/activate
        • pip install google-antigravity

Actual Behavior

The README only documents pip install google-antigravity with no mention of Mac-specific or Homebrew-specific setup steps, causing failures for users who manage their Python installation through Homebrew.

Additional Context

This is a documentation/installation UX issue that affects a significant portion of Mac developers who rely on Homebrew as their package manager. Adding a dedicated "macOS with Homebrew" section to the Installation part of the README would resolve this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions