Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAMLBuddy GitFAQ

Quick start

View as Markdown

Two ways to get a running Sandbox: UI or CLI.

In the web interface

Open the Sandboxes tab and click New Sandbox.

Image loading...Creating a new Sandbox

The only thing you have to provide is a name. Everything else is optional at this point: you can point the Sandbox at a repository to fetch, define the endpoints your application is exposed on, add first boot commands, set resources, variables, and tags. All of it is described in Configuration, and all of it can be changed later.

Submit the form and the Sandbox boots immediately. You are then redirected to the Sandbox Terminal you can type into right away, and with SSH connection details, so you can keep working from your own shell or your IDE - see Terminal and SSH.

Image loading...Sandbox terminal

From the CLI

1

Install the CLI and log in

bash
npm install -g bdy
bdy login
$$
2

Link your project

Run this inside your project directory. It connects the folder to a Buddy project, so the Sandbox knows which repository to pull code from:

bash
bdy proj link
$
3

Create a Sandbox with your app running

One command creates the machine, clones the repository into it, installs dependencies, and starts the application:

bash
bdy sb create -i my-sandbox \
  --fetch \
  --boot-command "npm install" \
  --app-command "npm start" \
  --wait-for-apps
$$$$$

--fetch pulls the linked project repository.
--boot-command runs once during setup.
--app-command defines a long-running application.
--wait-for-apps blocks until it is up.

If something fails, the setup log tells you what happened:

bash
bdy sb logs my-sandbox
$
4

Expose the app on a public URL

Add an HTTP endpoint pointing at the port your app listens on:

bash
bdy sb ep add my-sandbox -e 3000
bdy sb ep list my-sandbox
$$

The second command prints the public address. Open it in a browser - your app is live.

Warning
Your application must listen on 0.0.0.0, not 127.0.0.1.
A server bound to localhost is unreachable through an endpoint.
5

Open a shell inside

bash
bdy sb connect my-sandbox
$

You are now the buddy user with passwordless sudo. Install packages, inspect files, run anything.

6

Stop it and come back later

bash
bdy sb stop my-sandbox
$

The disk remains. When you start the Sandbox again, everything is where you left it.

bash
bdy sb start my-sandbox
$

Next

Last modified on Aug 14, 2026

Previous pageIntroductionNext pageConfiguration