Getting Started

Prerequisites

• A Buddy account (buddy.works)
• For npm installation: Node.js 14 or higher

Installation

npm (Recommended)

macOS / Linux:

bash
sudo npm i -g bdy
$

Windows:

powershell
npm i -g bdy

Homebrew (macOS)

bash
brew tap buddy/bdy
brew install bdy
$$

APT (Linux x64 / ARM64)

bash
sudo apt-get update && sudo apt-get install -y software-properties-common
sudo gpg --homedir /tmp --no-default-keyring --keyring /usr/share/keyrings/buddy.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys eb39332e766364ca6220e8dc631c5a16310cc0ad
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/buddy.gpg] https://es.buddy.works/bdy/apt-repo prod main" | sudo tee /etc/apt/sources.list.d/buddy.list > /dev/null
sudo apt-get update && sudo apt-get install -y bdy
$$$$

For ARM64, replace arch=amd64 with arch=arm64.

Chocolatey (Windows)

powershell
choco install bdy --pre

Direct Download

macOS (Apple Silicon):

bash
sudo mkdir -p -m 755 /usr/local/bin
curl https://es.buddy.works/bdy/prod/1.15.6/darwin-arm64.tar.gz -o bdy.tar.gz
sudo tar -zxf bdy.tar.gz -C /usr/local/bin/
$$$

Linux x64:

bash
curl https://es.buddy.works/bdy/prod/1.15.6/linux-x64.tar.gz -o bdy.tar.gz
sudo tar -zxf bdy.tar.gz -C /usr/local/bin/
$$

Linux ARM64:

bash
curl https://es.buddy.works/bdy/prod/1.15.6/linux-arm64.tar.gz -o bdy.tar.gz
sudo tar -zxf bdy.tar.gz -C /usr/local/bin/
$$

Windows x64:

powershell
curl https://es.buddy.works/bdy/prod/1.15.6/win-x64.zip -o bdy.zip
tar -xf bdy.zip

Verify Installation

bash
bdy version
$

Sign Up & Log In

Create an account from the CLI

New to Buddy? You can register without leaving the terminal:

bash
bdy register
$

You'll be asked to pick a region (us, eu, or as) and enter your details. You can also pass them up front:

bash
bdy register --region eu --email you@example.com --name "Your Name"
$

Once registration completes you're logged in straight away - there's no separate login step.

Log in to an existing account

bash
bdy login
$

To skip the interactive prompts, authenticate with a personal access token:

bash
bdy login --token <your-token> --workspace <workspace-handle>
$

Both --region and --api can also be set via the BUDDY_REGION and BUDDY_API_ENDPOINT variables.

Log out

bash
bdy logout
$

Updating

npm:

bash
sudo npm update -g bdy
sudo npm install -g bdy@latest
$$

Homebrew:

bash
brew upgrade bdy
$

APT:

bash
sudo apt-get update && sudo apt-get upgrade bdy
$

Chocolatey:

powershell
choco upgrade bdy