urnetwork-client

urnet-client

A minimal CLI for URnetwork (BringYour).

Quick Start

1. Build:

go build -o dist/urnet-client ./

1. Login:

./dist/urnet-client login --user_auth me@example.com --password 'secret'

1. Verify (if required):

./dist/urnet-client verify --user_auth me@example.com --code 123456

1. Start VPN:

sudo ./dist/urnet-client vpn \
  --tun utun10 \
  --default_route \
  --location_query="country:Germany"

Or run all in one command:

sudo ./dist/urnet-client quick-connect \
  --user_auth me@example.com \
  --password 'secret' \
  --default_route \
  --location_query="country:Germany" \
  --tun utun10

Quick Start (Docker)

# 1) Build image
make docker-build

# 2) Persist JWT locally
mkdir -p ~/.urnetwork

# 3) Login inside container
docker run --rm \
  -e URNETWORK_HOME=/data \
  -v ~/.urnetwork:/data \
  moghaddas/urnetwork-client:local login \
  --user_auth me@example.com --password 'secret'

# 4) Start VPN in container (Linux host)
docker run --rm -it \
  --cap-add NET_ADMIN \
  --device /dev/net/tun \
  -e URNETWORK_HOME=/data \
  -v ~/.urnetwork:/data \
  moghaddas/urnetwork-client:local vpn --tun urnet0

For full container usage (compose, multi-arch, macOS notes), see docs/docker.md.

Commands

• login, verify, save-jwt, mint-client
• quick-connect, vpn, socks
• find-providers, locations, open

Run ./dist/urnet-client --help for full command help.

Common Defaults

• API URL: https://api.bringyour.com
• Connect URL: wss://connect.bringyour.com
• JWT path: ~/.urnetwork/jwt

Docs

Detailed documentation is in docs/README.md:

• Quick Start
• Configuration
• Command Reference
• Examples
• Docker Guide
• Platform Notes

Security note

Prefer URNETWORK_PASSWORD over passing --password in command arguments, since args may appear in shell history and process listings.

Support

If you liked this project, please use this referral link.