bdy Agent CLI

bdy Agent CLI is an advanced command-line tool for managing network tunnels, allowing secure forwarding of TCP, TLS, and HTTP traffic from a local network to the internet. The agent can run as a system service and supports various tunnel types with rich configuration options.

Basic bdy agent commands

The main bdy agent command is used to manage the Buddy Agent service on Windows, macOS, and Linux systems.

bash
bdy agent
$

Managing tunnels

The bdy agent tunnel command allows you to create and manage various types of network tunnels.

bash
bdy agent tunnel
$

TCP tunnel

A TCP tunnel is an ideal solution for forwarding any TCP traffic (such as SSH, databases, Redis) to a service running in a private network.

bash
bdy agent tunnel tcp [options]
$

Parameters:

Example: exposing a MySQL database (port 3306) through a TCP tunnel:

bash
bdy agent tunnel tcp --region eu --whitelist 10.0.0.0/8 --subdomain mysql-db localhost:3306
$

bash
bdy tcp [options]
$

TLS tunnel

A TLS tunnel is used to securely forward TLS traffic (such as databases or custom TLS services) to an internal service with full control over certificates.

bash
bdy agent tunnel tls [options]
$

Parameters:

Example: creating a TLS tunnel with a custom certificate for a secure application

bash
bdy agent tunnel tls --cert /path/to/cert.pem --key /path/to/key.pem --subdomain secure-app --terminate agent localhost:8443
$

bash
bdy tls [options]
$

HTTP/HTTPS tunnel

An HTTP tunnel is the most commonly used tunnel type for forwarding HTTP/HTTPS traffic to web applications or APIs running in a private network.

bash
bdy agent tunnel http [options]
$

Paramters:

Example of an advanced HTTP tunnel with authentication, logging, and compression:

bash
bdy agent tunnel http \
  --region eu \
  --subdomain my-api \
  --auth apiuser:securepass \
  --log \
  --compression \
  --http2 \
  --header "X-Forwarded-Proto:https" \
  --circuit-breaker 0.8 \
  http://localhost:3000
$$$$$$$$$$

bash
bdy http [options]
$

Running a preconfigured tunnel:

You can start a tunnel using a preconfigured settings using:

bash
bdy agent tunnel start <name>
$

bdy agent tunnel list

You can list all the currently active tunnels using:

bash
bdy agent tunnel list
$

Przykładowa lista tunneli:

Checking tunnel status

By using a specific tunnel ID you can check its current status using:

bash
bdy agent tunnel status <id>
$

Status example:

default
Buddy Tunnel 1.9.37

Status:          OPEN
DNS:OK
Type:            HTTP
Region:          US
Target:          http://localhost:4000
HTTP:            Ver. 1.1
Entry:           https://next-test-app.us-1.key.sh

Latencies
  Region:        131ms
  Target:        1ms

Connections
  Current:       0
  Total:         3

Deleting a tunnel

Using tunnel's ID you can delete it using:

bash
bdy agent tunnel rm knrnLl0N
Tunnel stopped
$$

Managing tunnel configuration

Tunnel configuration allows you to save tunnel settings under a specific name, enabling quick startup of predefined connections without having to enter all parameters each time.

Adding tunnel configuration

bash
bdy config add [tcp/tls/http] [options] <name> [protocol://host:port]
$

Example of adding a HTTP configuration:

bash
bdy config add http my-web-app --region eu --subdomain webapp --log http://localhost:8080
$

Deleting tunnel configuration

bash
bdy config rm tunnel <name>
$

Displaying configured tunnels

You can display a list of currently configured tunnels using:

bash
bdy config get tunnnels
$

Tunnel configuration details display

You can display all the details for a specific tunnel configuration using:

bash
bdy config get tunnnel <name>
$

Currently, it is not possible to edit existing tunnel configurations.

Practical examples

Examples of adding a new tunnel with specific settings via the CLI.

Example: Sharing a Next.js application

bash
 bdy agent tunnel http --region us --whitelist 192.168.2.1 --subdomain next-test-app --domain key.sh --log http://localhost:4000
HTTP tunnel started
$$

On the UI side, our tunnel with the declared settings is available.

Image loading...

Example: Safe access to PostgreSQL

bash
bdy agent tunnel tcp --region eu --whitelist 203.0.113.0/24 --subdomain postgres-db localhost:5432
$