# bdy agent

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

## Usage

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

Install and run bdy as a background service on Windows, macOS and Linux that keeps tunnels up

## 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 |
| `-h, --help` | display help for command |

## Available Commands

| **Command** | **Description** |
| :--- | :--- |
| [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 |
| [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 |
| [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 |
| [target](https://buddy.works/docs/cli/agent/target.md) | Manage the agent's role 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 |

Documentation for bdy v1.25.38


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