# CLI

Command-line interface for interacting with Buddy services.

## Contents

- [Getting Started](/docs/cli/getting-started.md) - Install and set up the bdy command-line interface.
- [bdy](/docs/cli/reference.md) - Work seamlessly with Buddy from the command line.
- [bdy tunnel](/docs/cli/tunnel.md) - The tunnel command manages tunnels configuration
  - [start](/docs/cli/tunnel/start.md) - Starts tunnel from the configuration file.
  - [config](/docs/cli/tunnel/config.md) - The config command gives a quick way to create or update configuration file.
    - [add](/docs/cli/tunnel/config/add.md) - Add a new HTTP/TCP/TLS tunnel
      - [http](/docs/cli/tunnel/config/add/http.md) - Add a new HTTP tunnel
      - [tcp](/docs/cli/tunnel/config/add/tcp.md) - Add a new TCP tunnel
      - [tls](/docs/cli/tunnel/config/add/tls.md) - Add a new TLS tunnel
    - [get](/docs/cli/tunnel/config/get.md) - Get configuration tunnel/token/region/whitelist/timeout
      - [tunnel](/docs/cli/tunnel/config/get/tunnel.md) - Get tunnel configuration
      - [region](/docs/cli/tunnel/config/get/region.md) - Get region configuration
      - [timeout](/docs/cli/tunnel/config/get/timeout.md) - Get timeout configuration
      - [token](/docs/cli/tunnel/config/get/token.md) - Get token configuration
      - [tunnels](/docs/cli/tunnel/config/get/tunnels.md) - Get tunnels configuration
      - [whitelist](/docs/cli/tunnel/config/get/whitelist.md) - Get IP access restrictions
    - [rm](/docs/cli/tunnel/config/rm.md) - Remove tunnels configuration
      - [tunnel](/docs/cli/tunnel/config/rm/tunnel.md) - Remove tunnel configuration
      - [token](/docs/cli/tunnel/config/rm/token.md) - Remove tunnel token configuration
    - [set](/docs/cli/tunnel/config/set.md) - Set configuration token/region/whitelist/timeout
      - [region](/docs/cli/tunnel/config/set/region.md) - Set region
      - [timeout](/docs/cli/tunnel/config/set/timeout.md) - Set timeout
      - [token](/docs/cli/tunnel/config/set/token.md) - Set token
      - [whitelist](/docs/cli/tunnel/config/set/whitelist.md) - Set IP access restrictions
  - [http](/docs/cli/tunnel/http.md) - Starts a tunnel listening for HTTP/HTTPS traffic with a specific hostname.
  - [tcp](/docs/cli/tunnel/tcp.md) - Starts a tunnel which forwards all TCP traffic on a public port to a local address. This is extremely useful for exposing services that run non-HTTP traffic (ssh, sip, rdp, game servers, etc).
  - [tls](/docs/cli/tunnel/tls.md) - Starts a tunnel listening for TLS traffic on port 443 with a specific hostname.
- [bdy agent](/docs/cli/agent.md) - The agent command manages installation and execution of bdy as an operating system service on Windows, OS X and Linux systems
  - [start](/docs/cli/agent/start.md) - Starts the server agent
  - [stop](/docs/cli/agent/stop.md) - Stops the server agent
  - [install](/docs/cli/agent/install.md) - Install bdy server agent as operating system service or as an application
  - [tunnel](/docs/cli/agent/tunnel.md) - Manage agent's tunnels
    - [start](/docs/cli/agent/tunnel/start.md) - Starts tunnel from the configuration file.
    - [disable](/docs/cli/agent/tunnel/disable.md) - Disable Buddy agent tunnels
    - [enable](/docs/cli/agent/tunnel/enable.md) - Enable Buddy agent tunnels
    - [http](/docs/cli/agent/tunnel/http.md) - Starts a tunnel listening for HTTP/HTTPS traffic with a specific hostname.
    - [list](/docs/cli/agent/tunnel/list.md) - Manage agent's tunnels
    - [rm](/docs/cli/agent/tunnel/rm.md) - Manage agent's tunnels
    - [status](/docs/cli/agent/tunnel/status.md) - Manage agent's tunnels
    - [tcp](/docs/cli/agent/tunnel/tcp.md) - Starts a tunnel which forwards all TCP traffic on a public port to a local address. This is extremely useful for exposing services that run non-HTTP traffic (ssh, sip, rdp, game servers, etc).
    - [tls](/docs/cli/agent/tunnel/tls.md) - Starts a tunnel listening for TLS traffic on port 443 with a specific hostname.
  - [uninstall](/docs/cli/agent/uninstall.md) - Uninstall bdy server agent
  - [debug](/docs/cli/agent/debug.md) - Turn on/off debug mode for agent
  - [disable](/docs/cli/agent/disable.md) - Disable agent and all tunnels
  - [enable](/docs/cli/agent/enable.md) - Enable agent and all tunnels
  - [proxy](/docs/cli/agent/proxy.md) - Manage agent's target availability
    - [disable](/docs/cli/agent/proxy/disable.md) - Disable Buddy agent as a proxy
    - [enable](/docs/cli/agent/proxy/enable.md) - Enable Buddy agent as a proxy
    - [status](/docs/cli/agent/proxy/status.md) - Show the status of Buddy agent as a proxy
  - [restart](/docs/cli/agent/restart.md) - Restarts agent and all tunnels
  - [status](/docs/cli/agent/status.md) - Show the status of Buddy agent
  - [tags](/docs/cli/agent/tags.md) - Manage agent's tags
    - [get](/docs/cli/agent/tags/get.md) - Get agent's tags
    - [set](/docs/cli/agent/tags/set.md) - Set agent's tags
  - [target](/docs/cli/agent/target.md) - Manage agent's target availability
    - [disable](/docs/cli/agent/target/disable.md) - Disable Buddy agent as a target
    - [enable](/docs/cli/agent/target/enable.md) - Enable Buddy agent as a target
    - [status](/docs/cli/agent/target/status.md) - Show the status of Buddy agent as a target
  - [update](/docs/cli/agent/update.md) - Install a new version of Buddy agent
  - [user](/docs/cli/agent/user.md) - Specifies the operating system user under which the Agent will execute
  - [version](/docs/cli/agent/version.md) - Show the currently installed version
- [bdy tests](/docs/cli/tests.md) - Commands to interact with the test services
  - [visual](/docs/cli/tests/visual.md) - Commands to interact with the visual test service
    - [link](/docs/cli/tests/visual/link.md) - Link directory with a visual test suite
    - [session](/docs/cli/tests/visual/session.md) - Manage visual test sessions
      - [close](/docs/cli/tests/visual/session/close.md) - Close visual test session
      - [create](/docs/cli/tests/visual/session/create.md) - Run tests which use visual service plugin
    - [setup](/docs/cli/tests/visual/setup.md) - Install browser for visual test
    - [upload](/docs/cli/tests/visual/upload.md) - Create visual test session from storybook
  - [capture](/docs/cli/tests/capture.md) - Create visual test session for specific set of urls
  - [unit](/docs/cli/tests/unit.md) - Commands to interact with the unit test service
    - [link](/docs/cli/tests/unit/link.md) - Link directory with a unit test suite
    - [upload](/docs/cli/tests/unit/upload.md) - Upload unit test reports
- [bdy api](/docs/cli/api.md) - Contact Buddy API directly
  - [delete](/docs/cli/api/delete.md) - Make HTTP DELETE to Buddy API endpoint
  - [get](/docs/cli/api/get.md) - Make HTTP GET to Buddy API endpoint
  - [info](/docs/cli/api/info.md) - Show info about API endpoint
  - [list](/docs/cli/api/list.md) - List Buddy API endpoints
  - [patch](/docs/cli/api/patch.md) - Make HTTP PATCH to Buddy API endpoint
  - [post](/docs/cli/api/post.md) - Make HTTP POST to Buddy API endpoint
  - [put](/docs/cli/api/put.md) - Make HTTP PUT to Buddy API endpoint
- [bdy artifact](/docs/cli/artifact.md) - Commands to interact with the artifact service
  - [create](/docs/cli/artifact/create.md) - Create a new artifact. Required scopes: ARTIFACT_WRITE
  - [delete](/docs/cli/artifact/delete.md) - Delete an artifact and all its versions. Required scopes: ARTIFACT_MANAGE
  - [docker](/docs/cli/artifact/docker.md) - Login to Buddy Docker registry
    - [login](/docs/cli/artifact/docker/login.md) - Login to Buddy Docker registry
  - [download](/docs/cli/artifact/download.md) - Download file artifact. Required scopes: ARTIFACT_READ
  - [get](/docs/cli/artifact/get.md) - Get artifact by identifier. Required scopes: ARTIFACT_READ
  - [list](/docs/cli/artifact/list.md) - List artifacts. Required scopes: ARTIFACT_READ
  - [publish](/docs/cli/artifact/publish.md) - Publish file artifact. Required scopes: ARTIFACT_MANAGE
  - [version](/docs/cli/artifact/version.md) - Manage artifact versions
    - [delete](/docs/cli/artifact/version/delete.md) - Delete an artifact version. Required scopes: ARTIFACT_MANAGE
    - [get](/docs/cli/artifact/version/get.md) - Get version details. Required scopes: ARTIFACT_READ
    - [list](/docs/cli/artifact/version/list.md) - List all versions of an artifact. Required scopes: ARTIFACT_READ
- [bdy crawl](/docs/cli/crawl.md) - Commands to interact with the crawl service
  - [link](/docs/cli/crawl/link.md) - Link directory with a crawl suite
  - [run](/docs/cli/crawl/run.md) - Run a crawl session
- [bdy domain](/docs/cli/domain.md) - Manage domains
  - [buy](/docs/cli/domain/buy.md) - Buy domain
  - [get](/docs/cli/domain/get.md) - Get domain
  - [list](/docs/cli/domain/list.md) - List domains
  - [search](/docs/cli/domain/search.md) - Search domain
- [bdy login](/docs/cli/login.md) - Log in to Buddy
- [bdy logout](/docs/cli/logout.md) - Log out from Buddy
- [bdy pipeline](/docs/cli/pipeline.md) - Commands to interact with the pipeline service
  - [run](/docs/cli/pipeline/run.md) - Run pipeline. Required scopes: EXECUTION_INFO, EXECUTION_RUN
- [bdy project](/docs/cli/project.md) - Manage projects
  - [link](/docs/cli/project/link.md) - Link directory with project in Buddy
  - [list](/docs/cli/project/list.md) - List projects in current workspace
- [bdy sandbox](/docs/cli/sandbox.md) - Commands to interact with sandboxes
  - [start](/docs/cli/sandbox/start.md) - Start a stopped sandbox
  - [stop](/docs/cli/sandbox/stop.md) - Stop a running sandbox
  - [app](/docs/cli/sandbox/app.md) - Manage sandbox apps
    - [start](/docs/cli/sandbox/app/start.md) - Start sandbox app
    - [stop](/docs/cli/sandbox/app/stop.md) - Stop sandbox app
    - [add](/docs/cli/sandbox/app/add.md) - Add sandbox app
    - [list](/docs/cli/sandbox/app/list.md) - List all apps
    - [logs](/docs/cli/sandbox/app/logs.md) - Get app logs
    - [remove](/docs/cli/sandbox/app/remove.md) - Remove sandbox app
    - [status](/docs/cli/sandbox/app/status.md) - Get app status
  - [cp](/docs/cli/sandbox/cp.md) - Copy files/directories to sandbox
  - [create](/docs/cli/sandbox/create.md) - Create a new sandbox
  - [destroy](/docs/cli/sandbox/destroy.md) - Delete a sandbox
  - [endpoint](/docs/cli/sandbox/endpoint.md) - Manage sandbox endpoints
    - [add](/docs/cli/sandbox/endpoint/add.md) - Add an endpoint
    - [delete](/docs/cli/sandbox/endpoint/delete.md) - Delete an endpoint
    - [get](/docs/cli/sandbox/endpoint/get.md) - Get endpoint details
    - [list](/docs/cli/sandbox/endpoint/list.md) - List endpoints
  - [exec](/docs/cli/sandbox/exec.md) - Execute a command in sandbox
    - [command](/docs/cli/sandbox/exec/command.md) - Execute a command in sandbox
    - [kill](/docs/cli/sandbox/exec/kill.md) - Kill a running command
    - [list](/docs/cli/sandbox/exec/list.md) - List all commands
    - [logs](/docs/cli/sandbox/exec/logs.md) - Get command logs
    - [status](/docs/cli/sandbox/exec/status.md) - Get command status
  - [get](/docs/cli/sandbox/get.md) - Get sandbox details
  - [list](/docs/cli/sandbox/list.md) - List all sandboxes
  - [logs](/docs/cli/sandbox/logs.md) - Get sandbox logs
  - [restart](/docs/cli/sandbox/restart.md) - Restart a sandbox
  - [snapshot](/docs/cli/sandbox/snapshot.md) - Manage sandbox snapshots
    - [create](/docs/cli/sandbox/snapshot/create.md) - Create a snapshot
    - [delete](/docs/cli/sandbox/snapshot/delete.md) - Delete a snapshot
    - [get](/docs/cli/sandbox/snapshot/get.md) - Get snapshot details
    - [list](/docs/cli/sandbox/snapshot/list.md) - List snapshots
  - [status](/docs/cli/sandbox/status.md) - Get sandbox status
  - [update](/docs/cli/sandbox/update.md) - Update sandbox
  - [yaml](/docs/cli/sandbox/yaml.md) - Get sandbox yaml
- [bdy whoami](/docs/cli/whoami.md) - Check login information
- [bdy workspace](/docs/cli/workspace.md) - Manage workspaces
  - [get](/docs/cli/workspace/get.md) - Get current global workspace
  - [list](/docs/cli/workspace/list.md) - List available workspaces
  - [set](/docs/cli/workspace/set.md) - Set current global workspace
- [bdy version](/docs/cli/version.md)

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