# Install backplane-cli with Homebrew

CLI for interacting with the OpenShift Backplane API. Version 0.11.0 via Homebrew; verified 2026-07-02.

## Install

```sh
sudo av install brew:backplane-cli
```

Additional install commands:

### macOS

- Homebrew (100%):

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

  Evidence: local Homebrew formula metadata

## Package facts

- **Package key:** brew:backplane-cli
- **Package manager:** Homebrew
- **Package manager page:** <https://formulae.brew.sh/formula/backplane-cli>
- **Version:** 0.11.0
- **Source summary:** CLI for interacting with the OpenShift Backplane API
- **Homepage:** <https://github.com/openshift/backplane-cli>
- **Repository:** <https://github.com/openshift/backplane-cli>
- **Upstream docs:** <https://github.com/openshift/backplane-cli#readme>
- **License:** Apache-2.0
- **Source archive:** <https://github.com/openshift/backplane-cli/archive/refs/tags/v0.11.0.tar.gz>
- **Last updated:** 2026-07-02T08:03:07Z
- **Generated:** 2026-07-08T07:18:31+00:00

## Executables

- ocm-backplane (cli)
- ocm-backplane (alias)

## Build dependencies

- go

## Install behavior

- Post-install hook: not defined
- Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux

## Freshness

- Page generated: 2026-07-08
- Package-manager version: 0.11.0
- Package-manager updated: 2026-07-02
- Local data: ok
- Upstream repository: https://github.com/openshift/backplane-cli
- Upstream latest detected: v0.11.0 (current)
## Project history and usage

backplane-cli is an OpenShift operations CLI for interacting with the OpenShift Backplane API. It builds the ocm-backplane binary, which acts as an ocm plugin invoked as ocm backplane.

### Project history

The OpenShift GitHub repository was created in January 2023, and its releases list v0.1.0 in March 2023. The README describes the project as a CLI tool for backplane-api, installable from an OpenShift SRE Homebrew tap, downloadable from GitHub releases, or buildable from source.

The command set grew around managed OpenShift support workflows: cluster login/logout, console access, cloud credentials, SSM sessions, privilege elevation, script and managed-job execution, health checks, and status reporting.

### Adoption history

Adoption is intentionally narrow compared with general cloud CLIs. The project lives under the OpenShift organization, integrates with the OpenShift Cluster Manager CLI plugin model, and is packaged through Homebrew for operators who need repeatable local installation.

### How it is used

Operators use ocm backplane to log into a target cluster, source or export kubeconfig data, open the OpenShift console, retrieve temporary cloud-provider credentials, run managed jobs, and store configuration in ~/.config/backplane/config.json. The README warns that this config can contain PagerDuty API keys or JIRA tokens and should have restrictive permissions.

### Why package nerds care

backplane-cli is notable as vendor SRE tooling that still follows normal package-manager distribution. It shows the ocm plugin naming pattern in practice: the installed binary is ocm-backplane, but users get a subcommand-like ocm backplane UX.

### Timeline

- 2023: GitHub repository created under openshift/backplane-cli.
- 2023: v0.1.0 published in GitHub releases.
- 2025: v0.6.2 published as the release train continued.
- 2026: v0.10.2 published in GitHub releases.

### Related projects

- The README links backplane-api as the service API, openshift-online/ocm-cli as the plugin host, and uses oc/kubeconfig conventions for cluster access. PagerDuty and JIRA appear in documented credential/configuration flows.

### Sources

- <https://api.github.com/repos/openshift/backplane-cli>
- <https://api.github.com/repos/openshift/backplane-cli/releases>
- <https://github.com/openshift/backplane-cli#readme>
- <https://github.com/openshift/backplane-cli/blob/main/docs/PS1-setup.md>


## Security Notes

No matching local secret-handling manifest was found for backplane-cli. Nucleus package metadata is still published here so future coverage has a stable package URL.



## Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.


## Configuration files

- Unix: ~/.config/backplane/config.json

## Credential files

- Unix: ~/.config/backplane/config.json
## Source Database Details

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** backplane-cli
- **Version Scheme:** 0
- **Revision:** 0
- **Head Version:** HEAD
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** head, stable


## Related links

- [Cloud CLI packages](https://www.automicvault.com/pkg/cloud-clis/) - Belongs to a cloud or infrastructure command family.
- [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family.
- [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Networking and protocol packages](https://www.automicvault.com/pkg/networking-protocol-tools/) - Matched network, protocol, or remote-service metadata.
- [go](https://www.automicvault.com/pkg/brew/go/) - Build dependency declared by Homebrew.
- [akamai](https://www.automicvault.com/pkg/brew/akamai/) - Shares av.db curated category or tags: api, cli, cloud-infrastructure.
- [aws-sso-cli](https://www.automicvault.com/pkg/brew/aws-sso-cli/) - Shares av.db curated category or tags: api, cli, cloud-infrastructure.
- [cloudflare-cli4](https://www.automicvault.com/pkg/brew/cloudflare-cli4/) - Shares av.db curated category or tags: api, cli, cloud-infrastructure.
- [linode-cli](https://www.automicvault.com/pkg/brew/linode-cli/) - Shares av.db curated category or tags: api, cli, cloud-infrastructure.
- [ocm](https://www.automicvault.com/pkg/brew/ocm/) - Shares av.db curated category or tags: cli, cloud-infrastructure, openshift.
- [openshift-cli](https://www.automicvault.com/pkg/brew/openshift-cli/) - Shares av.db curated category or tags: cli, cloud-infrastructure, openshift.
- [osdctl](https://www.automicvault.com/pkg/brew/osdctl/) - Shares av.db curated category or tags: cli, cloud-infrastructure, openshift.
- [rosa-cli](https://www.automicvault.com/pkg/brew/rosa-cli/) - Shares av.db curated category or tags: cli, cloud-infrastructure, openshift.

## Combined YAML source

View the package source record on GitHub. [combined/backplane-cli.yml](https://github.com/automic-vault/db/blob/main/combined/backplane-cli.yml)


## Sources

- Nucleus package database
- Geiger risk classifier
- package-page enrichment
- curated configuration and credential file locations
- curated package history
- package version freshness
- av.db category and tag curation
- package relationship graph
- cross-ecosystem install command graph
