Installation

The Bindplane Client allows you to manage your Bindplane server remotely. It lets you view collectors, modify configurations, and create custom resource types.

Once installed, the bindplane command will be available and can be used to connect to a Bindplane Server. See the Configuration page for configuration instructions.

Installing Client

Linux

The client can be installed by downloading the correct package and placing the binary in your path.

Installing Client (AMD64)

mkdir bindplane
curl -L -o bindplane/bindplane.zip https://storage.googleapis.com/bindplane-op-releases/bindplane/latest/bindplane-ee-linux-amd64.zip
unzip bindplane/bindplane.zip -d bindplane/
sudo mv bindplane/bindplane /usr/local/bin/bindplane
mkdir -p ~/.bindplane/

Uninstalling Client

sudo rm /usr/local/bin/bindplane

macOS

Bindplane supports any macOS version 12 or newer.

Installing Client (AMD64)

mkdir bindplane
curl -L -o bindplane/bindplane.zip https://storage.googleapis.com/bindplane-op-releases/bindplane/latest/bindplane-ee-darwin-amd64.zip
unzip bindplane/bindplane.zip -d bindplane/
sudo mv bindplane/bindplane /usr/local/bin/bindplane
mkdir -p ~/.bindplane/

Installing Client (ARM64)

mkdir bindplane
curl -L -o bindplane/bindplane.zip https://storage.googleapis.com/bindplane-op-releases/bindplane/latest/bindplane-ee-darwin-arm64.zip
unzip bindplane/bindplane.zip -d bindplane/
sudo mv bindplane/bindplane /usr/local/bin/bindplane
mkdir -p ~/.bindplane/

NOTE

📘 Bindplane Server on macOS

The macOS client includes some server configuration, however Bindplane Server is not officially supported on macOS

Uninstalling Client

sudo rm -rf /usr/local/bin/bindplane
rm -rf ~/.bindplane

Windows

The Bindplane CLI tool supports Windows 10 and 11, as well as Windows Server 2016, 2019, 2022, 2025

Installing Client (AMD64)

Open PowerShell as Administrator (Right Click -> Run As Administrator)

$installPath = "$env:ProgramFiles\bindplane-cli"
if (-not (Test-Path -Path $installPath)) {
    New-Item -Path $installPath -ItemType Directory
    Write-Host "Folder created successfully: $installPath"
} else {
    Write-Host "Folder already exists: $installPath"
}
$currentMachinePath = [System.Environment]::GetEnvironmentVariable("Path", "Machine")
if ($currentMachinePath -notlike "*$installPath*") {
    [System.Environment]::SetEnvironmentVariable("Path", "$currentMachinePath;$installPath", "Machine")
}
$downloadPath = Join-Path -Path "$env:USERPROFILE\Downloads" -ChildPath bindplane-ee-windows-amd64.zip
Invoke-WebRequest -Uri https://storage.googleapis.com/bindplane-op-releases/bindplane/latest/bindplane-ee-windows-amd64.zip -OutFile $downloadPath
Expand-Archive -Path $downloadPath -DestinationPath $installPath -Force

Uninstalling Client

Open PowerShell as Administrator (Right Click -> Run As Administrator)

$installPath = "$env:ProgramFiles\bindplane-cli"
Remove-Item -Path $installPath -Recurse -Force
$currentMachinePath = [System.Environment]::GetEnvironmentVariable("Path", "Machine")
$newMachinePathArray = $currentMachinePath.Split(';') | Where-Object { $_ -ne $installPath }
[System.Environment]::SetEnvironmentVariable("Path", ($newMachinePathArray -join ';'), "Machine")