# CLI

> For AI agents: the complete documentation index is at https://buddy.works/llms.txt

Command-line interface for interacting with Buddy services.

## Contents

- [Getting Started](https://buddy.works/docs/cli/getting-started.md) - Install and set up the bdy command-line interface.
- [bdy](https://buddy.works/docs/cli/reference.md) - Work seamlessly with Buddy from the command line.
- [bdy tunnel](https://buddy.works/docs/cli/tunnel.md) - Start tunnels to local services and manage the tunnel configuration file
  - [start](https://buddy.works/docs/cli/tunnel/start.md) - Start the tunnels defined in the configuration file
  - [config](https://buddy.works/docs/cli/tunnel/config.md) - Create or edit the tunnel configuration file
    - [add](https://buddy.works/docs/cli/tunnel/config/add.md) - Add an HTTP, TCP or TLS tunnel to the configuration file
      - [http](https://buddy.works/docs/cli/tunnel/config/add/http.md) - Add an HTTP tunnel to the configuration file
      - [tcp](https://buddy.works/docs/cli/tunnel/config/add/tcp.md) - Add a TCP tunnel to the configuration file
      - [tls](https://buddy.works/docs/cli/tunnel/config/add/tls.md) - Add a TLS tunnel to the configuration file
    - [get](https://buddy.works/docs/cli/tunnel/config/get.md) - Show tunnel settings: tunnels, token, region, whitelist or timeout
      - [tunnel](https://buddy.works/docs/cli/tunnel/config/get/tunnel.md) - Show one tunnel from the configuration file
      - [region](https://buddy.works/docs/cli/tunnel/config/get/region.md) - Show the configured default region
      - [timeout](https://buddy.works/docs/cli/tunnel/config/get/timeout.md) - Show the configured connection timeout
      - [token](https://buddy.works/docs/cli/tunnel/config/get/token.md) - Show the configured tunnel token
      - [tunnels](https://buddy.works/docs/cli/tunnel/config/get/tunnels.md) - List all tunnels defined in the configuration file
      - [whitelist](https://buddy.works/docs/cli/tunnel/config/get/whitelist.md) - Show the configured IP whitelist
    - [rm](https://buddy.works/docs/cli/tunnel/config/rm.md) - Remove a tunnel or the token from the configuration file
      - [tunnel](https://buddy.works/docs/cli/tunnel/config/rm/tunnel.md) - Remove a tunnel from the configuration file
      - [token](https://buddy.works/docs/cli/tunnel/config/rm/token.md) - Remove the tunnel token from the configuration file
    - [set](https://buddy.works/docs/cli/tunnel/config/set.md) - Set global tunnel settings: token, region, whitelist or timeout
      - [region](https://buddy.works/docs/cli/tunnel/config/set/region.md) - Set the default region for new tunnels
      - [timeout](https://buddy.works/docs/cli/tunnel/config/set/timeout.md) - Set the default connection timeout in seconds
      - [token](https://buddy.works/docs/cli/tunnel/config/set/token.md) - Set the token used to authorize tunnels
      - [whitelist](https://buddy.works/docs/cli/tunnel/config/set/whitelist.md) - Set the default IP whitelist (CIDRs) for tunnels
  - [http](https://buddy.works/docs/cli/tunnel/http.md) - Start a tunnel that exposes a local HTTP/HTTPS service under a public hostname
  - [tcp](https://buddy.works/docs/cli/tunnel/tcp.md) - Start a tunnel that forwards TCP traffic from a public port to a local address, for non-HTTP services such as SSH, RDP, SIP or game servers
  - [tls](https://buddy.works/docs/cli/tunnel/tls.md) - Start a tunnel that forwards TLS traffic on port 443 for a hostname to a local address
- [bdy agent](https://buddy.works/docs/cli/agent.md) - Install and run bdy as a background service on Windows, macOS and Linux that keeps tunnels up
  - [start](https://buddy.works/docs/cli/agent/start.md) - Start the agent service
  - [stop](https://buddy.works/docs/cli/agent/stop.md) - Stop the agent service
  - [install](https://buddy.works/docs/cli/agent/install.md) - Install the agent as a system service or as a user application
  - [tunnel](https://buddy.works/docs/cli/agent/tunnel.md) - Manage tunnels run by the agent
    - [start](https://buddy.works/docs/cli/agent/tunnel/start.md) - Add the tunnels from the configuration file to the agent
    - [disable](https://buddy.works/docs/cli/agent/tunnel/disable.md) - Disable tunneling in the agent
    - [enable](https://buddy.works/docs/cli/agent/tunnel/enable.md) - Enable tunneling in the agent
    - [http](https://buddy.works/docs/cli/agent/tunnel/http.md) - Add an HTTP tunnel run by the agent
    - [list](https://buddy.works/docs/cli/agent/tunnel/list.md) - List tunnels run by the agent
    - [rm](https://buddy.works/docs/cli/agent/tunnel/rm.md) - Remove a tunnel from the agent by ID
    - [status](https://buddy.works/docs/cli/agent/tunnel/status.md) - Show the status of the agent's tunnels, or of one tunnel by ID
    - [tcp](https://buddy.works/docs/cli/agent/tunnel/tcp.md) - Add a TCP tunnel run by the agent
    - [tls](https://buddy.works/docs/cli/agent/tunnel/tls.md) - Add a TLS tunnel run by the agent
  - [uninstall](https://buddy.works/docs/cli/agent/uninstall.md) - Uninstall the agent service
  - [debug](https://buddy.works/docs/cli/agent/debug.md) - Turn agent debug logging on or off
  - [disable](https://buddy.works/docs/cli/agent/disable.md) - Disable the agent service and all its tunnels
  - [enable](https://buddy.works/docs/cli/agent/enable.md) - Enable the agent service and all its tunnels
  - [proxy](https://buddy.works/docs/cli/agent/proxy.md) - Manage whether Buddy may use the agent as a proxy, for example to reach an SSH target through it
    - [disable](https://buddy.works/docs/cli/agent/proxy/disable.md) - Stop Buddy from using the agent as a proxy
    - [enable](https://buddy.works/docs/cli/agent/proxy/enable.md) - Allow Buddy to use the agent as a proxy, for example for SSH targets behind it
    - [status](https://buddy.works/docs/cli/agent/proxy/status.md) - Show whether Buddy may use the agent as a proxy
  - [restart](https://buddy.works/docs/cli/agent/restart.md) - Restart the agent service and all its tunnels
  - [status](https://buddy.works/docs/cli/agent/status.md) - Show the agent service status
  - [tags](https://buddy.works/docs/cli/agent/tags.md) - Manage the tags that identify this agent
    - [get](https://buddy.works/docs/cli/agent/tags/get.md) - Show the agent's tags
    - [set](https://buddy.works/docs/cli/agent/tags/set.md) - Replace the agent's tags
  - [target](https://buddy.works/docs/cli/agent/target.md) - Manage the agent's role as a deployment target
    - [disable](https://buddy.works/docs/cli/agent/target/disable.md) - Disable the agent as a deployment target
    - [enable](https://buddy.works/docs/cli/agent/target/enable.md) - Enable the agent as a deployment target
    - [status](https://buddy.works/docs/cli/agent/target/status.md) - Show whether the agent is enabled as a deployment target
  - [update](https://buddy.works/docs/cli/agent/update.md) - Update the agent to the latest version
  - [user](https://buddy.works/docs/cli/agent/user.md) - Set the operating system user the agent service runs as
  - [version](https://buddy.works/docs/cli/agent/version.md) - Show the installed agent version
- [bdy tests](https://buddy.works/docs/cli/tests.md) - Manage unit tests and visual regression (Storybook, URL captures, test runners)
  - [visual](https://buddy.works/docs/cli/tests/visual.md) - Manage visual regression testing across Storybook, URL captures, and test runners
    - [link](https://buddy.works/docs/cli/tests/visual/link.md) - Link current directory to a visual test suite Required scopes: VISUAL_TEST_WRITE
    - [session](https://buddy.works/docs/cli/tests/visual/session.md) - Manage visual test sessions
      - [close](https://buddy.works/docs/cli/tests/visual/session/close.md) - Close a parallel visual test session early (skip auto-close timeout)
      - [create](https://buddy.works/docs/cli/tests/visual/session/create.md) - Run a test command and create a visual test session from emitted snapshots
    - [setup](https://buddy.works/docs/cli/tests/visual/setup.md) - Install the resource-discovery browser used by `bdy tests visual session create`
    - [upload](https://buddy.works/docs/cli/tests/visual/upload.md) - Upload a built Storybook to create a visual test session
  - [capture](https://buddy.works/docs/cli/tests/capture.md) - Create a visual test session from an explicit URL list, a URLs file, or a sitemap
  - [unit](https://buddy.works/docs/cli/tests/unit.md) - Manage unit testing (JUnit XML report uploads, suite linking)
    - [link](https://buddy.works/docs/cli/tests/unit/link.md) - Link current directory to a unit test suite Required scopes: UNIT_TEST_WRITE
    - [upload](https://buddy.works/docs/cli/tests/unit/upload.md) - Upload unit test reports
- [bdy api](https://buddy.works/docs/cli/api.md) - Call the Buddy REST API directly
  - [delete](https://buddy.works/docs/cli/api/delete.md) - Send a DELETE request to an API endpoint
  - [get](https://buddy.works/docs/cli/api/get.md) - Send a GET request to an API endpoint
  - [info](https://buddy.works/docs/cli/api/info.md) - Show the documentation of an API endpoint
  - [list](https://buddy.works/docs/cli/api/list.md) - List Buddy API endpoints
  - [patch](https://buddy.works/docs/cli/api/patch.md) - Send a PATCH request to an API endpoint
  - [post](https://buddy.works/docs/cli/api/post.md) - Send a POST request to an API endpoint
  - [put](https://buddy.works/docs/cli/api/put.md) - Send a PUT request to an API endpoint
- [bdy artifact](https://buddy.works/docs/cli/artifact.md) - Manage artifacts: file, Docker and Composer packages with versions
  - [composer](https://buddy.works/docs/cli/artifact/composer.md) - Publish Composer packages to a Composer artifact
    - [publish](https://buddy.works/docs/cli/artifact/composer/publish.md) - Publish the Composer package in a directory as a new artifact version Required scopes: ARTIFACT_WRITE
  - [create](https://buddy.works/docs/cli/artifact/create.md) - Create an artifact Required scopes: ARTIFACT_WRITE
  - [delete](https://buddy.works/docs/cli/artifact/delete.md) - Delete an artifact and all its versions Required scopes: ARTIFACT_MANAGE
  - [docker](https://buddy.works/docs/cli/artifact/docker.md) - Work with the Buddy Docker registry
    - [login](https://buddy.works/docs/cli/artifact/docker/login.md) - Log in to the Buddy Docker registry Required scopes: USER_READ
  - [download](https://buddy.works/docs/cli/artifact/download.md) - Download a version of a file artifact Required scopes: ARTIFACT_READ
  - [get](https://buddy.works/docs/cli/artifact/get.md) - Show artifact details Required scopes: ARTIFACT_READ
  - [list](https://buddy.works/docs/cli/artifact/list.md) - List artifacts Required scopes: ARTIFACT_READ
  - [open](https://buddy.works/docs/cli/artifact/open.md) - Open this resource in a browser Required scopes: ARTIFACT_READ
  - [publish](https://buddy.works/docs/cli/artifact/publish.md) - Upload a directory as a new version of a file artifact Required scopes: ARTIFACT_WRITE
  - [update](https://buddy.works/docs/cli/artifact/update.md) - Update an artifact's notes Required scopes: ARTIFACT_WRITE
  - [version](https://buddy.works/docs/cli/artifact/version.md) - Manage artifact versions
    - [create](https://buddy.works/docs/cli/artifact/version/create.md) - Create an artifact version Required scopes: ARTIFACT_WRITE
    - [delete](https://buddy.works/docs/cli/artifact/version/delete.md) - Delete an artifact version Required scopes: ARTIFACT_MANAGE
    - [get](https://buddy.works/docs/cli/artifact/version/get.md) - Show artifact version details Required scopes: ARTIFACT_READ
    - [list](https://buddy.works/docs/cli/artifact/version/list.md) - List versions of an artifact Required scopes: ARTIFACT_READ
    - [open](https://buddy.works/docs/cli/artifact/version/open.md) - Open this resource in a browser Required scopes: ARTIFACT_READ
    - [update](https://buddy.works/docs/cli/artifact/version/update.md) - Update an artifact version's notes Required scopes: ARTIFACT_WRITE
- [bdy context](https://buddy.works/docs/cli/context.md) - Manage connection and workspace/project contexts
  - [add](https://buddy.works/docs/cli/context/add.md) - Save a named context without activating it
  - [list](https://buddy.works/docs/cli/context/list.md) - List built-in and saved contexts without resolving their sources
  - [remove](https://buddy.works/docs/cli/context/remove.md) - Remove a saved context; removing the active context selects default
  - [show](https://buddy.works/docs/cli/context/show.md) - Show resolved context and value sources without changing the active context
  - [use](https://buddy.works/docs/cli/context/use.md) - Select the globally active context
- [bdy crawl](https://buddy.works/docs/cli/crawl.md) - Crawl websites into Markdown, HTML and screenshots
  - [link](https://buddy.works/docs/cli/crawl/link.md) - Link current directory to a crawl suite Required scopes: CRAWL_WRITE
  - [run](https://buddy.works/docs/cli/crawl/run.md) - Crawl a URL and download the results (screenshots, Markdown, HTML) to a directory
- [bdy discover](https://buddy.works/docs/cli/discover.md) - Discover CLI commands as JSON, without login or network access
- [bdy distro](https://buddy.works/docs/cli/distro.md) - Manage distributions that route traffic from domains to artifacts, sandboxes and other targets
  - [create](https://buddy.works/docs/cli/distro/create.md) - Create a distribution Required scopes: DISTRIBUTION_WRITE
  - [delete](https://buddy.works/docs/cli/distro/delete.md) - Delete a distribution Required scopes: DISTRIBUTION_MANAGE
  - [get](https://buddy.works/docs/cli/distro/get.md) - Show distribution details Required scopes: DISTRIBUTION_READ
  - [list](https://buddy.works/docs/cli/distro/list.md) - List distributions Required scopes: DISTRIBUTION_READ
  - [open](https://buddy.works/docs/cli/distro/open.md) - Open this resource in a browser Required scopes: DISTRIBUTION_READ
  - [route](https://buddy.works/docs/cli/distro/route.md) - Manage routes of a distribution
    - [create](https://buddy.works/docs/cli/distro/route/create.md) - Add a route to a distribution Required scopes: DISTRIBUTION_WRITE
    - [delete](https://buddy.works/docs/cli/distro/route/delete.md) - Delete a route Required scopes: DISTRIBUTION_MANAGE
    - [get](https://buddy.works/docs/cli/distro/route/get.md) - Show route details Required scopes: DISTRIBUTION_READ
    - [list](https://buddy.works/docs/cli/distro/route/list.md) - List routes of a distribution Required scopes: DISTRIBUTION_READ
    - [open](https://buddy.works/docs/cli/distro/route/open.md) - Open this resource in a browser Required scopes: DISTRIBUTION_READ
    - [update](https://buddy.works/docs/cli/distro/route/update.md) - Update a route Required scopes: DISTRIBUTION_WRITE
  - [update](https://buddy.works/docs/cli/distro/update.md) - Update a distribution Required scopes: DISTRIBUTION_WRITE
- [bdy domain](https://buddy.works/docs/cli/domain.md) - Manage zones (called "domains" in Buddy). A zone can be used in distribution routes. Zones can be apex (example.com) or multi-level (my-app.example.dev) — the whole string is one zone
  - [buy](https://buddy.works/docs/cli/domain/buy.md) - Search for and buy a domain Required scopes: DOMAIN_MANAGE
  - [create](https://buddy.works/docs/cli/domain/create.md) - Add a domain you already own (pointed) or a private domain Required scopes: DOMAIN_MANAGE
  - [delete](https://buddy.works/docs/cli/domain/delete.md) - Delete a domain with all its records Required scopes: DOMAIN_MANAGE
  - [get](https://buddy.works/docs/cli/domain/get.md) - Show domain details Required scopes: DOMAIN_READ
  - [import](https://buddy.works/docs/cli/domain/import.md) - Create or update private domains from YAML Required scopes: DOMAIN_MANAGE
  - [list](https://buddy.works/docs/cli/domain/list.md) - List domains in a workspace Required scopes: DOMAIN_READ
  - [open](https://buddy.works/docs/cli/domain/open.md) - Open this resource in a browser Required scopes: DOMAIN_READ
  - [search](https://buddy.works/docs/cli/domain/search.md) - Search for available domains by name or description Required scopes: DOMAIN_READ
  - [update](https://buddy.works/docs/cli/domain/update.md) - Replace the records of a domain from YAML Required scopes: DOMAIN_WRITE
  - [yaml](https://buddy.works/docs/cli/domain/yaml.md) - Print the records YAML of a domain Required scopes: DOMAIN_READ
- [bdy environment](https://buddy.works/docs/cli/environment.md) - Manage environments
  - [create](https://buddy.works/docs/cli/environment/create.md) - Create an environment Required scopes: ENVIRONMENT_WRITE
  - [delete](https://buddy.works/docs/cli/environment/delete.md) - Delete an environment Required scopes: ENVIRONMENT_MANAGE
  - [get](https://buddy.works/docs/cli/environment/get.md) - Show environment details Required scopes: ENVIRONMENT_READ
  - [list](https://buddy.works/docs/cli/environment/list.md) - List environments Required scopes: ENVIRONMENT_READ
  - [open](https://buddy.works/docs/cli/environment/open.md) - Open this resource in a browser Required scopes: ENVIRONMENT_READ
  - [update](https://buddy.works/docs/cli/environment/update.md) - Update an environment Required scopes: ENVIRONMENT_WRITE
- [bdy integration](https://buddy.works/docs/cli/integration.md) - Manage integrations
  - [add](https://buddy.works/docs/cli/integration/add.md) - Print a link to the Buddy page for adding an integration. Integrations hold credentials, so they are added in the app Required scopes: INTEGRATION_READ
  - [delete](https://buddy.works/docs/cli/integration/delete.md) - Delete an integration Required scopes: INTEGRATION_MANAGE
  - [exec](https://buddy.works/docs/cli/integration/exec.md) - Use the integration's MCP server: list its tools, show one, call it, and manage executions
    - [call](https://buddy.works/docs/cli/integration/exec/call.md) - Call a tool of the integration's MCP server Required scopes: INTEGRATION_USE
    - [kill](https://buddy.works/docs/cli/integration/exec/kill.md) - Cancel a running execution Required scopes: INTEGRATION_USE
    - [list](https://buddy.works/docs/cli/integration/exec/list.md) - List integration executions Required scopes: INTEGRATION_READ
    - [logs](https://buddy.works/docs/cli/integration/exec/logs.md) - Show execution logs Required scopes: INTEGRATION_READ
    - [status](https://buddy.works/docs/cli/integration/exec/status.md) - Show the status of an execution Required scopes: INTEGRATION_READ
    - [tool](https://buddy.works/docs/cli/integration/exec/tool.md) - Show a tool with its arguments (input schema) Required scopes: INTEGRATION_USE
    - [tools](https://buddy.works/docs/cli/integration/exec/tools.md) - List the tools of the integration's MCP server Required scopes: INTEGRATION_USE
  - [get](https://buddy.works/docs/cli/integration/get.md) - Show integration details Required scopes: INTEGRATION_READ
  - [list](https://buddy.works/docs/cli/integration/list.md) - List integrations Required scopes: INTEGRATION_READ
  - [types](https://buddy.works/docs/cli/integration/types.md) - List integration types that can be added, with what each is for
  - [update](https://buddy.works/docs/cli/integration/update.md) - Update an integration's notes. Credentials and settings are changed in the app Required scopes: INTEGRATION_MANAGE
- [bdy login](https://buddy.works/docs/cli/login.md) - Log in to Buddy Required scopes: WORKSPACE_READ
- [bdy logout](https://buddy.works/docs/cli/logout.md) - Log out from Buddy
- [bdy mcp](https://buddy.works/docs/cli/mcp.md) - Run a local stdio MCP server proxying to the Buddy remote MCP server
- [bdy pipeline](https://buddy.works/docs/cli/pipeline.md) - Manage pipelines and their runs
  - [create](https://buddy.works/docs/cli/pipeline/create.md) - Create a pipeline from a YAML definition Required scopes: PIPELINE_WRITE
  - [delete](https://buddy.works/docs/cli/pipeline/delete.md) - Delete a pipeline Required scopes: PIPELINE_MANAGE
  - [get](https://buddy.works/docs/cli/pipeline/get.md) - Show pipeline details Required scopes: PIPELINE_READ
  - [list](https://buddy.works/docs/cli/pipeline/list.md) - List pipelines in a project Required scopes: PIPELINE_READ
  - [open](https://buddy.works/docs/cli/pipeline/open.md) - Open this resource in a browser Required scopes: PIPELINE_READ
  - [run](https://buddy.works/docs/cli/pipeline/run.md) - Start, follow and manage pipeline runs
    - [start](https://buddy.works/docs/cli/pipeline/run/start.md) - Start a pipeline run and follow its progress Required scopes: PIPELINE_RUN
    - [approve](https://buddy.works/docs/cli/pipeline/run/approve.md) - Approve a pipeline run waiting for approval Required scopes: PIPELINE_RUN
    - [cancel](https://buddy.works/docs/cli/pipeline/run/cancel.md) - Cancel a pipeline run in progress Required scopes: PIPELINE_RUN
    - [find](https://buddy.works/docs/cli/pipeline/run/find.md) - Find runs in the recent history of a pipeline Required scopes: PIPELINE_READ
    - [list](https://buddy.works/docs/cli/pipeline/run/list.md) - List runs of a pipeline Required scopes: PIPELINE_READ
    - [logs](https://buddy.works/docs/cli/pipeline/run/logs.md) - Show the logs of a pipeline run Required scopes: PIPELINE_READ
    - [open](https://buddy.works/docs/cli/pipeline/run/open.md) - Open this resource in a browser Required scopes: PIPELINE_READ
    - [retry](https://buddy.works/docs/cli/pipeline/run/retry.md) - Resume a failed or terminated pipeline run using the API retry operation Required scopes: PIPELINE_RUN
    - [status](https://buddy.works/docs/cli/pipeline/run/status.md) - Show the status of a pipeline run Required scopes: PIPELINE_READ
  - [update](https://buddy.works/docs/cli/pipeline/update.md) - Update a pipeline from a YAML definition Required scopes: PIPELINE_WRITE
  - [yaml](https://buddy.works/docs/cli/pipeline/yaml.md) - Print a pipeline definition as YAML Required scopes: PIPELINE_READ
- [bdy project](https://buddy.works/docs/cli/project.md) - Manage projects
  - [create](https://buddy.works/docs/cli/project/create.md) - Create a project Required scopes: PROJECT_WRITE
  - [delete](https://buddy.works/docs/cli/project/delete.md) - Delete a project with its pipelines, environments and repository Required scopes: PROJECT_MANAGE
  - [get](https://buddy.works/docs/cli/project/get.md) - Show project details Required scopes: PROJECT_READ
  - [link](https://buddy.works/docs/cli/project/link.md) - Link the current directory to a project so commands use it by default Required scopes: PROJECT_WRITE
  - [list](https://buddy.works/docs/cli/project/list.md) - List projects in current workspace Required scopes: PROJECT_READ
  - [open](https://buddy.works/docs/cli/project/open.md) - Open this resource in a browser Required scopes: PROJECT_READ
  - [update](https://buddy.works/docs/cli/project/update.md) - Update project settings Required scopes: PROJECT_WRITE
- [bdy register](https://buddy.works/docs/cli/register.md) - Create a Buddy account
- [bdy sandbox](https://buddy.works/docs/cli/sandbox.md) - Create and manage cloud sandboxes: run commands and apps, take snapshots, expose endpoints
  - [start](https://buddy.works/docs/cli/sandbox/start.md) - Start a stopped sandbox Required scopes: SANDBOX_WRITE
  - [stop](https://buddy.works/docs/cli/sandbox/stop.md) - Stop a running sandbox Required scopes: SANDBOX_WRITE
  - [app](https://buddy.works/docs/cli/sandbox/app.md) - Manage long-running apps in a sandbox
    - [start](https://buddy.works/docs/cli/sandbox/app/start.md) - Start an app Required scopes: SANDBOX_WRITE
    - [stop](https://buddy.works/docs/cli/sandbox/app/stop.md) - Stop an app Required scopes: SANDBOX_WRITE
    - [add](https://buddy.works/docs/cli/sandbox/app/add.md) - Add an app to a sandbox Required scopes: SANDBOX_WRITE
    - [list](https://buddy.works/docs/cli/sandbox/app/list.md) - List apps in a sandbox Required scopes: SANDBOX_READ
    - [logs](https://buddy.works/docs/cli/sandbox/app/logs.md) - Show app logs Required scopes: SANDBOX_READ
    - [remove](https://buddy.works/docs/cli/sandbox/app/remove.md) - Remove an app from a sandbox Required scopes: SANDBOX_WRITE
    - [status](https://buddy.works/docs/cli/sandbox/app/status.md) - Show app status Required scopes: SANDBOX_READ
  - [cp](https://buddy.works/docs/cli/sandbox/cp.md) - Copy files and directories between the local machine and a sandbox (downloading needs only SANDBOX_READ, uploading SANDBOX_WRITE) Required scopes: SANDBOX_READ, SANDBOX_WRITE
  - [create](https://buddy.works/docs/cli/sandbox/create.md) - Create a new sandbox. Pre-installed tools: node 24, docker 29, go 1.25, python 3, git, curl, wget, jq, rsync, ripgrep, unzip, nano, bdy Required scopes: SANDBOX_WRITE
  - [destroy](https://buddy.works/docs/cli/sandbox/destroy.md) - Delete a sandbox Required scopes: SANDBOX_MANAGE
  - [endpoint](https://buddy.works/docs/cli/sandbox/endpoint.md) - Manage public endpoints that expose sandbox ports
    - [add](https://buddy.works/docs/cli/sandbox/endpoint/add.md) - Add an endpoint exposing a sandbox port. The server must listen on 0.0.0.0, otherwise it is unreachable Required scopes: SANDBOX_WRITE
    - [delete](https://buddy.works/docs/cli/sandbox/endpoint/delete.md) - Delete an endpoint Required scopes: SANDBOX_WRITE
    - [get](https://buddy.works/docs/cli/sandbox/endpoint/get.md) - Show endpoint details Required scopes: SANDBOX_READ
    - [list](https://buddy.works/docs/cli/sandbox/endpoint/list.md) - List endpoints of a sandbox Required scopes: SANDBOX_READ
  - [exec](https://buddy.works/docs/cli/sandbox/exec.md) - Run commands in a sandbox and manage them
    - [command](https://buddy.works/docs/cli/sandbox/exec/command.md) - Execute a command in sandbox. Commands run as buddy with passwordless sudo. Use sudo for package installs Required scopes: SANDBOX_USE
    - [kill](https://buddy.works/docs/cli/sandbox/exec/kill.md) - Kill a running command Required scopes: SANDBOX_USE
    - [list](https://buddy.works/docs/cli/sandbox/exec/list.md) - List commands started in a sandbox Required scopes: SANDBOX_READ
    - [logs](https://buddy.works/docs/cli/sandbox/exec/logs.md) - Show the output of a command started with exec Required scopes: SANDBOX_READ
    - [status](https://buddy.works/docs/cli/sandbox/exec/status.md) - Show the status of a command started with exec Required scopes: SANDBOX_READ
  - [fetch](https://buddy.works/docs/cli/sandbox/fetch.md) - Manage sources (repositories and artifacts) fetched into a sandbox
    - [add](https://buddy.works/docs/cli/sandbox/fetch/add.md) - Add a source to fetch into a sandbox: the project repository (default), a public repository (--repository) or an artifact (--artifact) Required scopes: SANDBOX_WRITE
    - [delete](https://buddy.works/docs/cli/sandbox/fetch/delete.md) - Remove a source from a sandbox. Files already fetched into the sandbox are left in place Required scopes: SANDBOX_WRITE
    - [get](https://buddy.works/docs/cli/sandbox/fetch/get.md) - Show fetch details Required scopes: SANDBOX_READ
    - [list](https://buddy.works/docs/cli/sandbox/fetch/list.md) - List sources fetched into a sandbox with their revision and how far behind they are Required scopes: SANDBOX_READ
    - [refetch](https://buddy.works/docs/cli/sandbox/fetch/refetch.md) - Fetch a source again Required scopes: SANDBOX_WRITE
  - [get](https://buddy.works/docs/cli/sandbox/get.md) - Show sandbox details Required scopes: SANDBOX_READ
  - [list](https://buddy.works/docs/cli/sandbox/list.md) - List sandboxes Required scopes: SANDBOX_READ
  - [logs](https://buddy.works/docs/cli/sandbox/logs.md) - Show the sandbox setup log: stdout/stderr and exit codes from boot commands (--boot-command) and from each fetch source (--fetch, including the optional build= step) Does NOT include: - application output → use "bdy sb app logs <sandbox-identifier> <app-id>" - exec output → use "bdy sb exec logs <sandbox-identifier> <command-id>" Required scopes: SANDBOX_READ
  - [open](https://buddy.works/docs/cli/sandbox/open.md) - Open this resource in a browser Required scopes: SANDBOX_READ
  - [restart](https://buddy.works/docs/cli/sandbox/restart.md) - Restart a sandbox Required scopes: SANDBOX_WRITE
  - [snapshot](https://buddy.works/docs/cli/sandbox/snapshot.md) - Manage sandbox snapshots
    - [create](https://buddy.works/docs/cli/sandbox/snapshot/create.md) - Create a snapshot of a sandbox Required scopes: SANDBOX_WRITE
    - [delete](https://buddy.works/docs/cli/sandbox/snapshot/delete.md) - Delete a snapshot Required scopes: SANDBOX_MANAGE
    - [get](https://buddy.works/docs/cli/sandbox/snapshot/get.md) - Show snapshot details Required scopes: SANDBOX_READ
    - [list](https://buddy.works/docs/cli/sandbox/snapshot/list.md) - List snapshots of a sandbox Required scopes: SANDBOX_READ
    - [open](https://buddy.works/docs/cli/sandbox/snapshot/open.md) - Open this resource in a browser Required scopes: SANDBOX_READ
  - [ssh](https://buddy.works/docs/cli/sandbox/ssh.md) - Open an interactive SSH session to a sandbox Authenticates with the SSH key you added to your Buddy account - the session always runs as the buddy user, whatever login is sent Arguments for ssh itself, or a command to run instead of a shell, go after -- Required scopes: SANDBOX_READ
  - [status](https://buddy.works/docs/cli/sandbox/status.md) - Show sandbox status Required scopes: SANDBOX_READ
  - [update](https://buddy.works/docs/cli/sandbox/update.md) - Update a sandbox from a YAML definition Required scopes: SANDBOX_WRITE
  - [yaml](https://buddy.works/docs/cli/sandbox/yaml.md) - Print a sandbox definition as YAML Required scopes: SANDBOX_READ
- [bdy target](https://buddy.works/docs/cli/target.md) - Manage deployment targets
  - [create](https://buddy.works/docs/cli/target/create.md) - Create a target from YAML Required scopes: TARGET_WRITE
  - [delete](https://buddy.works/docs/cli/target/delete.md) - Delete a target Required scopes: TARGET_MANAGE
  - [exec](https://buddy.works/docs/cli/target/exec.md) - Run commands on a target and manage executions
    - [command](https://buddy.works/docs/cli/target/exec/command.md) - Execute a command on a target Required scopes: TARGET_USE
    - [kill](https://buddy.works/docs/cli/target/exec/kill.md) - Cancel a running execution Required scopes: TARGET_USE
    - [list](https://buddy.works/docs/cli/target/exec/list.md) - List target executions Required scopes: TARGET_READ
    - [logs](https://buddy.works/docs/cli/target/exec/logs.md) - Show execution logs Required scopes: TARGET_READ
    - [status](https://buddy.works/docs/cli/target/exec/status.md) - Show the status of an execution Required scopes: TARGET_READ
  - [get](https://buddy.works/docs/cli/target/get.md) - Show target details Required scopes: TARGET_READ
  - [list](https://buddy.works/docs/cli/target/list.md) - List targets Required scopes: TARGET_READ
  - [open](https://buddy.works/docs/cli/target/open.md) - Open this resource in a browser Required scopes: TARGET_READ
  - [update](https://buddy.works/docs/cli/target/update.md) - Update a target from YAML Required scopes: TARGET_WRITE
- [bdy update](https://buddy.works/docs/cli/update.md) - Show the installed bdy version and how to update when a newer one is available
- [bdy variable](https://buddy.works/docs/cli/variable.md) - Manage environment variables
  - [create](https://buddy.works/docs/cli/variable/create.md) - Create a variable Required scopes: VARIABLE_WRITE
  - [delete](https://buddy.works/docs/cli/variable/delete.md) - Delete a variable Required scopes: VARIABLE_MANAGE
  - [get](https://buddy.works/docs/cli/variable/get.md) - Show variable details Required scopes: VARIABLE_READ
  - [list](https://buddy.works/docs/cli/variable/list.md) - List variables Required scopes: VARIABLE_READ
  - [update](https://buddy.works/docs/cli/variable/update.md) - Update a variable Required scopes: VARIABLE_WRITE
- [bdy whoami](https://buddy.works/docs/cli/whoami.md) - Show who you are logged in as Required scopes: USER_READ
- [bdy workspace](https://buddy.works/docs/cli/workspace.md) - Manage workspaces
  - [get](https://buddy.works/docs/cli/workspace/get.md) - Show the default workspace
  - [list](https://buddy.works/docs/cli/workspace/list.md) - List available workspaces Required scopes: WORKSPACE_READ
  - [open](https://buddy.works/docs/cli/workspace/open.md) - Open this resource in a browser Required scopes: WORKSPACE_READ
  - [set](https://buddy.works/docs/cli/workspace/set.md) - Set the default workspace used by other commands Required scopes: WORKSPACE_READ
- [bdy yaml](https://buddy.works/docs/cli/yaml.md) - Browse and validate Buddy pipeline YAML
  - [actions](https://buddy.works/docs/cli/yaml/actions.md) - Browse Buddy YAML action types
    - [info](https://buddy.works/docs/cli/yaml/actions/info.md) - Show action schema and example for a type
    - [list](https://buddy.works/docs/cli/yaml/actions/list.md) - List all action types
  - [pipeline](https://buddy.works/docs/cli/yaml/pipeline.md) - Show pipeline YAML schema and examples
  - [validate](https://buddy.works/docs/cli/yaml/validate.md) - Validate a pipeline YAML file

---
Original source: https://buddy.works/docs/cli