Skip to content

[SREP-4818] docs: add intructions to install with Homebrew #939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gvnnn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[SREP-4818] docs: add intructions to install with Homebrew #939

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@ backplane-cli is a CLI tool to interact with [backplane api](https://github.com/

Go should be installed in your local system with version 1.19

### Option 1: Download from release
### MacOS
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 12, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use official product casing: macOS.

MacOS should be macOS for user-facing documentation consistency.

Suggested fix 
-### MacOS
+### macOS
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### MacOS
### macOS
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 14, Update the user-facing heading text that currently
reads "MacOS" to use the official product casing "macOS" in the README (change
the heading line with "### MacOS" to "### macOS") so documentation is consistent
with product naming.


```brew
brew install backplane-cli
```


### Download from release

Comment on lines +14 to 22
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 12, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Scope the Go prerequisite to source builds only.

With Homebrew install added, the global Go 1.19 prerequisite is misleading. Go is only required for “Build from source.”

Suggested fix 
-Go should be installed in your local system with version 1.19 
+For building from source, Go should be installed locally (minimum version 1.19).
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 14 - 22, The README currently implies Go 1.19 is a
global prerequisite; restrict the Go prerequisite to source builds by moving or
duplicating the Go 1.19 requirement into the "Build from source" section and
removing it from top-level or MacOS install instructions (specifically update
the "MacOS" section and the global prerequisites so Homebrew install example for
backplane-cli doesn't imply Go is required); ensure the "Build from source"
heading explicitly lists "Go 1.19" and any build steps that require it so users
installing via Homebrew or downloads aren't misled.

Download the latest binary from the GitHub [releases](https://github.com/openshift/backplane-cli/releases) page.

Expand All @@ -24,7 +31,7 @@ $ chmod +x ocm-backplane
$ mv ocm-backplane $GOBIN
```

### Option 2: Build from source
### Build from source

First clone the repository somewhere in your `$PATH`. A common place would be within your `$GOPATH`.

Expand Down