# bdy

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

## Usage

```bash
bdy [options] [command]
```

Work seamlessly with Buddy from the command line.

## Options

| **Option** | **Description** |
| :--- | :--- |
| `--context <name>` | Connection and scope context: default, git, link or a saved name. Overrides the globally active context for this invocation. |
| `--examples` | Show only examples; with this flag --format accepts text, json or jsonl |
| `--verbose` | Show REST API requests, responses, timing and retries on stderr |
| `-v, --version` | Output the bdy version |
| `-h, --help` | display help for command |

## Available Commands

| **Command** | **Description** |
| :--- | :--- |
| [tunnel](https://buddy.works/docs/cli/tunnel.md) | Start tunnels to local services and manage the tunnel configuration file |
| [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 |
| [tests](https://buddy.works/docs/cli/tests.md) | Manage unit tests and visual regression (Storybook, URL captures, test
  runners) |
| [api](https://buddy.works/docs/cli/api.md) | Call the Buddy REST API directly |
| [artifact](https://buddy.works/docs/cli/artifact.md) | Manage artifacts: file, Docker and Composer packages with versions |
| [context](https://buddy.works/docs/cli/context.md) | Manage connection and workspace/project contexts |
| [crawl](https://buddy.works/docs/cli/crawl.md) | Crawl websites into Markdown, HTML and screenshots |
| [discover](https://buddy.works/docs/cli/discover.md) | Discover CLI commands as JSON, without login or network access |
| [distro](https://buddy.works/docs/cli/distro.md) | Manage distributions that route traffic from domains to artifacts, sandboxes
  and other targets |
| [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 |
| [environment](https://buddy.works/docs/cli/environment.md) | Manage environments |
| [integration](https://buddy.works/docs/cli/integration.md) | Manage integrations |
| [login](https://buddy.works/docs/cli/login.md) | Log in to Buddy Required scopes: WORKSPACE_READ |
| [logout](https://buddy.works/docs/cli/logout.md) | Log out from Buddy |
| [mcp](https://buddy.works/docs/cli/mcp.md) | Run a local stdio MCP server proxying to the Buddy remote MCP server |
| [pipeline](https://buddy.works/docs/cli/pipeline.md) | Manage pipelines and their runs |
| [project](https://buddy.works/docs/cli/project.md) | Manage projects |
| [register](https://buddy.works/docs/cli/register.md) | Create a Buddy account |
| [sandbox](https://buddy.works/docs/cli/sandbox.md) | Create and manage cloud sandboxes: run commands and apps, take snapshots,
  expose endpoints |
| [target](https://buddy.works/docs/cli/target.md) | Manage deployment targets |
| [update](https://buddy.works/docs/cli/update.md) | Show the installed bdy version and how to update when a newer one is available |
| [variable](https://buddy.works/docs/cli/variable.md) | Manage environment variables |
| [whoami](https://buddy.works/docs/cli/whoami.md) | Show who you are logged in as Required scopes: USER_READ |
| [workspace](https://buddy.works/docs/cli/workspace.md) | Manage workspaces |
| [yaml](https://buddy.works/docs/cli/yaml.md) | Browse and validate Buddy pipeline YAML |

Documentation for bdy v1.25.38


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