Client Usage

Output Modes

The client supports:

• plain
• table
• json

Example:

./vaylix-client --url 'vaylix://vaylix:vaylix@127.0.0.1:9173?output=json'

CLI flags override values parsed from the URL when both are provided.

Local-Only Commands

These commands never go over the wire:

• help
• exit
• quit

That keeps transport opcodes reserved for server-recognized operations only.

Authentication

Authentication is enabled by default. The development defaults are:

• username: vaylix
• password: vaylix

Use URL credentials:

./vaylix-client \
  --url 'vaylix://vaylix:vaylix@127.0.0.1:9173'

Or pass credentials explicitly:

./vaylix-client \
  --host 127.0.0.1 \
  --port 9173 \
  --user vaylix \
  --password vaylix

--disable-auth is only for trusted local test servers that were also started with auth disabled.

Transport Compression

Outbound frame compression is enabled by default with zstd.

Disable it only for compatible local/test peers or wire-format debugging:

./vaylix-client --disable-compression

URL form:

vaylix://vaylix:vaylix@127.0.0.1:9173?compression=none

Compression is selected during startup negotiation.

TLS and mTLS

The client uses plaintext TCP by default. Enable TLS with --ssl or ssl=true in the URL:

./vaylix-client \
  --url 'vaylix://vaylix:vaylix@127.0.0.1:9173?ssl=true'

If you need a custom CA:

./vaylix-client \
  --ssl \
  --tls-ca-cert ./certs/ca.crt

If the server requires mTLS, provide both a client certificate chain and its matching private key:

./vaylix-client \
  --ssl \
  --tls-ca-cert ./certs/server-ca.crt \
  --tls-client-cert ./certs/client.crt \
  --tls-client-key ./certs/client.key

URL form is also supported:

vaylix://vaylix:vaylix@127.0.0.1:9173?ssl=true&client_cert=/certs/client.crt&client_key=/certs/client.key