Bridge Docs — One CLI for all your agent context

Bridge can be installed in three main ways today:

the official release installers
Homebrew on macOS
from source with Rust

This page also covers where the binary is installed, how PATH setup works, and how Bridge shell completions are installed or generated manually.

Choose an install method

Method	Best for	Notes
Official installer	Most users	Downloads the latest GitHub release, verifies checksums, installs the binary, and tries to wire up PATH and completions
Homebrew	macOS users who already use Homebrew	Quick to install, but shell integration depends on your local Homebrew setup
Source install	Contributors and advanced users	Requires Rust and installs from the checked-out code

Platform support

The current installer scripts support these release targets:

Installer	Supported targets
`install.sh`	macOS `x86_64`, macOS `aarch64`, Linux `x86_64`
`install.ps1`	Windows `x86_64`

Current installer limitations worth knowing:

Linux arm64 is not supported by install.sh today
Windows ARM64 is not supported by install.ps1 today

Recommended: install from the latest release

The official installers are the best default because they:

fetch the latest GitHub release automatically
download the matching archive for your platform
verify SHA-256 checksums before installing
install the binary into a user-local directory
try to update PATH and install shell completions

macOS / Linux
Windows

curl -fsSL https://bridge.ls/install | sh

The shell installer installs Bridge to:

~/.bridge/bin/bridge

irm https://bridge.ls/install | iex

The PowerShell installer installs Bridge to:

$env:USERPROFILE\.bridge\bin\bridge.exe

What the installers do

Both installers follow the same safety model:

fetch the latest GitHub release tag
download the platform-specific archive
download checksums.txt
compute the local SHA-256 digest
abort if the checksum does not match
install the verified binary into your user-local Bridge directory

The installers fail hard if checksum verification cannot complete. They do not install an unverified binary.

Install with Homebrew

If you are on macOS and prefer Homebrew, Bridge is documented in the repo as:

brew install usebridgeai/tap/bridge

After installation, verify that Homebrew put bridge on your PATH:

bridge --version

If you want explicit shell completion setup after a Homebrew install, you can always generate completions manually with bridge completions <shell>.

Install from source

Source installs are most useful if you are developing Bridge itself or testing changes before a release. Bridge currently declares Rust 1.94.1 in its crate metadata, so use a compatible Rust toolchain.

macOS / Linux
Windows

If you are inside the CLI crate directory:

cargo install --path .

If you are working from the monorepo root, the Rust crate lives in cli/:

cargo install --path ./cli

That installs bridge through Cargo’s normal binary path:

~/.cargo/bin

If you are inside the CLI crate directory:

cargo install --path .

If you are working from the monorepo root, the Rust crate lives in cli/:

cargo install --path ./cli

That installs bridge through Cargo’s normal binary path:

%USERPROFILE%\.cargo\bin

Verify the installation

No matter which install path you use, the two quickest checks are:

bridge --version
bridge --help

If those work, Bridge is installed and visible on your PATH.

PATH setup

macOS / Linux
Windows

The shell installer tries to update PATH based on your detected shell:

zsh: ~/.zprofile on macOS if it already exists, plus ~/.zshrc
bash: ~/.bash_profile on macOS or ~/.bashrc on Linux
fish: ~/.config/fish/config.fish if it already exists

If the installer cannot detect your shell, or if the expected profile file does not exist, it prints the PATH export you should add manually:

export PATH="$HOME/.bridge/bin:$PATH"

For fish, the equivalent is:

fish_add_path ~/.bridge/bin

The PowerShell installer appends Bridge’s install directory to the user PATH environment variable.After installation, restart your terminal so the updated PATH is picked up.If you need to add it manually, run this in PowerShell:

$bridgePath = "$env:USERPROFILE\.bridge\bin"
[Environment]::SetEnvironmentVariable("PATH", "$env:PATH;$bridgePath", "User")

Shell completions

Bridge can generate completions for these shells:

bash
elvish
fish
powershell
zsh

The command surface is:

bridge completions <SHELL>

Automatic completion setup by the official installers

The release installers currently try to wire up completions like this:

Shell	Automatic installer behavior
`zsh`	Writes `~/.zfunc/_bridge` and adds `~/.zfunc` to `fpath` in `~/.zshrc` if needed
`bash`	Writes `~/.local/share/bash-completion/completions/bridge`
`fish`	Writes `~/.config/fish/completions/bridge.fish`
`powershell`	Appends the generated completion script to `$PROFILE`
`elvish`	No automatic installer wiring today

If completion setup fails during installation, the installers keep going and Bridge still installs successfully.

Manual completion setup

zsh
bash
fish
PowerShell
elvish

mkdir -p ~/.zfunc
bridge completions zsh > ~/.zfunc/_bridge

If ~/.zfunc is not already on your fpath, add this to ~/.zshrc:

fpath=(~/.zfunc $fpath)

mkdir -p ~/.local/share/bash-completion/completions
bridge completions bash > ~/.local/share/bash-completion/completions/bridge

mkdir -p ~/.config/fish/completions
bridge completions fish > ~/.config/fish/completions/bridge.fish

$profileDir = Split-Path $PROFILE
New-Item -ItemType Directory -Force -Path $profileDir | Out-Null
bridge completions powershell >> $PROFILE

Bridge can generate an Elvish completion script, but the current installers do not place it automatically. Use your normal Elvish completion-loading flow:

bridge completions elvish

Common install issues

`bridge` is still not found after installation

Your PATH change may not be loaded in the current terminal session yet. Restart your shell or add Bridge’s install directory to PATH manually.

Checksum verification failed

Bridge will not install a release archive whose SHA-256 digest does not match checksums.txt. Try again, or inspect the release assets and checksums on GitHub before installing manually.

My architecture is not supported by the installer

The current scripts do not support Linux arm64 or Windows ARM64. In those cases, use a supported release target or build from source if your toolchain and platform can support it.

Completions were not loaded automatically

Bridge may already be installed correctly even if completion setup failed. Generate the completion script manually with bridge completions <shell> and place it in your shell’s completion directory.

Uninstall

macOS / Linux
Windows

If you installed with the official release scripts:

rm -rf ~/.bridge

If you installed from source with Cargo:

cargo uninstall bridge-cli

If you installed with the official release scripts:

Remove-Item -Recurse $env:USERPROFILE\.bridge

If you installed from source with Cargo:

cargo uninstall bridge-cli

After uninstalling, remove any PATH or shell-profile lines you added manually if you no longer want them.

Quickstart

Once Bridge is installed, use the quickstart to create bridge.yaml and connect your first provider.

Commands

See the full CLI reference, including the bridge completions command.

Development

If you are building Bridge itself, see the contributor workflow and local Rust setup.

​Choose an install method

​Platform support

​Recommended: install from the latest release

​What the installers do

​Install with Homebrew

​Install from source

​Verify the installation

​PATH setup

​Shell completions

​Automatic completion setup by the official installers

​Manual completion setup

​Common install issues

​Uninstall

​Related pages

Quickstart

Commands

Development

Choose an install method

Platform support

Recommended: install from the latest release

What the installers do

Install with Homebrew

Install from source

Verify the installation

PATH setup

Shell completions

Automatic completion setup by the official installers

Manual completion setup

Common install issues

Uninstall

Related pages