banish.shdocs
HomeGitHub
Getting started / Install
View as Markdown

Install

banish is a single Go binary with no external runtime dependencies. Pick the install path for your platform, then wire it into your agent in one more command.

Install script (macOS and Linux)

curl -fsSL https://banish.sh/install.sh | bash

The script downloads the right binary for your architecture - Intel or Apple Silicon on macOS, any glibc distribution on Linux. It installs to /usr/local/bin when that is writable, and otherwise to ~/.local/bin so the common case needs no password. Set BANISH_INSTALL_DIR to choose the location yourself.

To pin a specific release, set BANISH_VERSION to a tag. To install the newest release candidate instead of the latest stable release:

curl -fsSL https://banish.sh/install.sh | BANISH_CHANNEL=beta bash

Windows

irm https://banish.sh/install.ps1 | iex

Run that in PowerShell.

From source

If you have a Go toolchain, install straight from the module path:

go install go.banish.sh/banish/cmd/banish@latest

The full package reference and API docs live on pkg.go.dev/go.banish.sh/banish.

banish never changes state on its own. It runs read-only commands through a filter and returns compact text. Anything that mutates state still prompts you, exactly as it would without banish.

Verify

banish version

Once that prints a version, continue to the quick start.

Update and uninstall

Update in place, or check first:

banish upgrade
banish upgrade --check

Developers who want release candidates can run banish upgrade --channel beta or set {"channel": "beta"} in ~/.banish/config.json; everyone else only ever sees stable releases.

banish also prints a one-line notice on an interactive terminal when a newer release is out; set BANISH_NO_UPDATE_CHECK=1 to silence it. To remove banish, run banish uninstall (add --purge to also delete ~/.banish). See every command for the full reference.

Install banish - shell output compaction for Claude Code and MCP agents - banish