carta
wscat(1)

wscat1

Communicate over websocket

Usage

wscat {[options] (--listen <port> | --connect <url>)}

Options

-V, --version

output the version number

--auth <username:password>

add basic HTTP authentication header

--ca <ca>

specify a Certificate Authority (--connect only)

--cert <cert>

specify a Client SSL Certificate (--connect only)

--host <host>

optional host

--key <key>

specify a Client SSL Certificate's key (--connect only)

--max-redirects [num]

maximum number of redirects allowed (default: 10)

--no-color

run without color

--passphrase [passphrase]

specify a Client SSL Certificate Key's passphrase (--connect only). If you don't provide a value, it will be prompted for

--proxy <[protocol://]host[:port]>

connect via a proxy. Proxy must support CONNECT method

--slash

enable slash commands for control frames (/ping [data], /pong [data], /close [code [, reason]]) (--connect only)

-c, --connect <url>

connect to a WebSocket server

-H, --header <header:value>

set an HTTP header. Repeat to set multiple (--connect only) (default: [])

-l, --listen <port>

listen on port

-L, --location

follow redirects

-n, --no-check

do not check for unauthorized certificates (--connect only)

-o, --origin <origin>

optional origin

-p, --protocol <version>

optional protocol version

-P, --show-ping-pong

print a notification when a ping or pong is received (--connect only)

-s, --subprotocol <protocol>

optional subprotocol. Repeat to specify more than one (default: [])

-w, --wait <seconds>

wait given seconds after executing command

-x, --execute <command>

execute command after connecting (--connect only)

-h, --help

display help for command

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie)

--ca since Debian 11 (Bullseye); --cert since Debian 11 (Bullseye); --execute since Debian 11 (Bullseye); --key since Debian 11 (Bullseye); --location since Debian 12 (Bookworm); --max-redirects since Debian 12 (Bookworm); --no-color since Debian 11 (Bullseye); --passphrase since Debian 11 (Bullseye); --proxy since Debian 11 (Bullseye); --show-ping-pong since Debian 11 (Bullseye); --slash since Debian 11 (Bullseye); --wait since Debian 11 (Bullseye); -L since Debian 12 (Bookworm); -P since Debian 11 (Bullseye); -w since Debian 11 (Bullseye); -x since Debian 11 (Bullseye).

From node-ws 8.18.1+~cs14.18.2-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.