Installation
Quick Install (Recommended)
Section titled “Quick Install (Recommended)”The easiest way to install is with our install script:
curl -sSL https://raw.githubusercontent.com/zach-snell/obx/main/install.sh | bashThis automatically:
- Detects your OS and architecture
- Downloads the correct binary
- Installs to
/usr/local/bin
No sudo? Install to your home directory:
Section titled “No sudo? Install to your home directory:”curl -sSL https://raw.githubusercontent.com/zach-snell/obx/main/install.sh | bash -s -- --userThis installs to ~/.local/bin instead.
Manual Download
Section titled “Manual Download”curl -sSL https://github.com/zach-snell/obx/releases/latest/download/obx-darwin-arm64 -o obxchmod +x obxsudo mv obx /usr/local/bin/curl -sSL https://github.com/zach-snell/obx/releases/latest/download/obx-darwin-amd64 -o obxchmod +x obxsudo mv obx /usr/local/bin/curl -sSL https://github.com/zach-snell/obx/releases/latest/download/obx-linux-amd64 -o obxchmod +x obxsudo mv obx /usr/local/bin/curl -sSL https://github.com/zach-snell/obx/releases/latest/download/obx-linux-arm64 -o obxchmod +x obxsudo mv obx /usr/local/bin/Download obx-windows-amd64.exe from the releases page.
Go Install
Section titled “Go Install”If you have Go installed:
go install github.com/zach-snell/obx/cmd/obx@latestmv $(go env GOPATH)/bin/server $(go env GOPATH)/bin/obxBuild from Source
Section titled “Build from Source”git clone https://github.com/zach-snell/obx.gitcd obxgo build -o obx ./cmd/obxUpgrading
Section titled “Upgrading”Just run the install script again:
curl -sSL https://raw.githubusercontent.com/zach-snell/obx/main/install.sh | bashIt always fetches the latest version.
Verify Installation
Section titled “Verify Installation”obx --helpYou should see usage information.