[{"_1":2,"_155":-5,"_156":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_134":135},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":11,"_131":-5,"_132":133},"canonicalUrl","https://hub.docker.com/r/solsson/websocat/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","solsson","reponame","websocat","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2019-06-18T08:54:37.672804Z","description","https://github.com/solsson/websocat","is_private","last_updated","2019-06-18T09:16:47.679811Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",2061655,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# websocat\nNetcat, curl and socat for [WebSockets](https://en.wikipedia.org/wiki/WebSocket).\n\n[![Build Status](https://travis-ci.org/vi/websocat.svg?branch=master)](https://travis-ci.org/vi/websocat)\n[![Gitter](https://badges.gitter.im/websocat.svg)](https://gitter.im/websocat/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge)\n\n## Examples\n\n### Connect to public echo server\n\n```\n$ websocat ws://echo.websocket.org\n123\n123\nABC\nABC\n```\n\n### Serve and connect\n\n```\nA$ websocat -s 1234\nListening on ws://127.0.0.1:1234/\nABC\n123\n\nB$ websocat ws://127.0.0.1:1234/\nABC\n123\n```\n\n### Open a tab in Chromium using remote debugging.\n\n```\n$ chromium --remote-debugging-port=9222&\n$ curl -sg http://127.0.0.1:9222/json/new | grep webSocketDebuggerUrl | cut -d'\"' -f4 | head -1\nws://127.0.0.1:9222/devtools/page/A331E56CCB8615EB4FCB720425A82259\n$ echo 'Page.navigate {\"url\":\"https://example.com\"}' | websocat -n1 --jsonrpc ws://127.0.0.1:9222/devtools/page/A331E56CCB8615EB4FCB720425A82259\n{\"id\":2,\"result\":{\"frameId\":\"A331E56CCB8615EB4FCB720425A82259\",\"loaderId\":\"EF5AAD19F2F8BB27FAF55F94FFB27DF9\"}}\n\n```\n\n### Proxy TCP connections to WebSocket connections and back.\n\n```\n$ websocat --oneshot -b ws-l:127.0.0.1:1234 tcp:127.0.0.1:22&\n$ websocat --oneshot -b tcp-l:127.0.0.1:1236 ws://127.0.0.1:1234/&\n$ nc 127.0.0.1 1236\nSSH-2.0-OpenSSH_7.4p1 Debian-10+deb9u3\nqwertyu\nProtocol mismatch.\n```\n\n\n### Broadcast all messages between connected WebSocket clients\n\n```\nA$ websocat -t ws-l:127.0.0.1:1234 broadcast:mirror:\nB$ websocat ws://127.0.0.1:1234\nC$ websocat ws://127.0.0.1:1234\n```\n\nSee [moreexamples.md](./moreexamples.md) for further examples.\n\n## Features\n\n* Connecting to and serving WebSockets from command line.\n* Executing external program and making it communicate to WebSocket using stdin/stdout.\n* Text and binary modes, converting between lines (or null-terminated records) and messages.\n* Inetd mode, UNIX sockets (including abstract namespaced on Linux).\n* Integration with Nginx using TCP or UNIX sockets.\n* Directly using unauthenticated SOCKS5 servers for connecting to WebSockets and listening WebSocket connection.\n* Auto-reconnect and connection-reuse modes.\n* Linux, Windows and Mac support, with [pre-built executables][releases].\n* Low-level WebSocket clients and servers with overridable underlying transport connection, e.g. calling external program to serve as a transport for websocat (for SSL, proxying, etc.).\n* Buildable by rust starting from v1.30. Websocat version 1.2.0 (or from [a tag](https://github.com/vi/websocat/releases/tag/last_version_that_supports_rust_1_28)) should be buildable by 1.28.0. Websocat version 1.1.0 and earlier should be buildable with Rust v1.23.0. There is legacy non-async version buildable by even older Rust.\n\n[releases]:https://github.com/vi/websocat/releases\n\n# Installation\n\nThere are multiple options for installing WebSocat. From easy to hard:\n\n* If you're on Linux Debian or Ubuntu (or other dpkg-based), try downloading a pre-build deb package from [GitHub releases][releases] and install from GUI or with command like `gdebi websocat_..._.deb`\n* If you're on FreeBSD, you may install WebSocat with the following command: `pkg install websocat`.\n* If you're on Mac, you can do `brew install websocat`.\n* Download a pre-build executable and install it to PATH.\n* Install the [Rust toolchain](https://rustup.rs/) and do `cargo install --features=ssl websocat`. If something fails with a `-sys` crate, try without `--features=ssl`;\n* Build Websocat from source code (see below), then move `target/release/websocat` somewhere to the PATH.\n\n## Usage\n\n```\nwebsocat 1.4.0\nVitaly \"_Vi\" Shukela \nCommand-line client for web sockets, like netcat/curl/socat for ws://.\n\nUSAGE:\n websocat ws://URL | wss://URL (simple client)\n websocat -s port (simple server)\n websocat [FLAGS] [OPTIONS] (advanced mode)\n\nFLAGS:\n (some flags are hidden, see --help=long)\n -e, --set-environment Set WEBSOCAT_* environment variables when doing exec:/cmd:/sh-c:\n Currently it's WEBSOCAT_URI and WEBSOCAT_CLIENT for\n request URI and client address (if TCP)\n Beware of ShellShock or similar security problems.\n -E, --exit-on-eof Close a data transfer direction if the other one reached EOF\n --jsonrpc Format messages you type as JSON RPC 2.0 method calls. First word\n becomes method name, the rest becomes parameters, possibly automatically\n wrapped in [].\n -0, --null-terminated Use \\0 instead of \\n for linemode\n -1, --one-message Send and/or receive only one message. Use with --no-close and/or -u/-U.\n --oneshot Serve only once. Not to be confused with -1 (--one-message)\n -q Suppress all diagnostic messages, except of startup errors\n -s, --server-mode Simple server mode: specify TCP port or addr:port as single argument\n -S, --strict strict line/message mode: drop too long messages instead of splitting\n them, drop incomplete lines.\n -k, --insecure Accept invalid certificates and hostnames while connecting to TLS\n -u, --unidirectional Inhibit copying data in one direction\n -U, --unidirectional-reverse Inhibit copying data in the other direction (or maybe in both directions\n if combined with -u)\n -v Increase verbosity level to info or further\n -b, --binary Send message to WebSockets as binary messages\n -n, --no-close Don't send Close message to websocket on EOF\n -t, --text Send message to WebSockets as text messages\n\nOPTIONS:\n (some options are hidden, see --help=long)\n --socks5 \n Use specified address:port as a SOCKS5 proxy. Note that proxy authentication is not supported yet. Example:\n --socks5 127.0.0.1:9050\n\n -B, --buffer-size Maximum message size, in bytes [default: 65536]\n -H, --header ...\n Add custom HTTP header to websocket client request. Separate header name and value with a colon and\n optionally a single space. Can be used multiple times. Note that single -H may eat multiple further\n arguments, leading to confusing errors. Specify headers at the end or with equal sign like -H='X: y'.\n --server-header ...\n Add custom HTTP header to websocket upgrade reply. Separate header name and value with a colon and\n optionally a single space. Can be used multiple times. Note that single -H may eat multiple further\n arguments, leading to confusing errors.\n -h, --help \n See the help.\n --help=short is the list of easy options and address types\n --help=long lists all options and types (see [A] markers)\n --help=doc also shows longer description and examples.\n --conncap Maximum number of simultaneous connections for listening mode\n --origin Add Origin HTTP header to websocket client request\n --pkcs12-der \n Pkcs12 archive needed to accept SSL connections, certificate and key.\n A command to output it: openssl pkcs12 -export -out output.pkcs12 -inkey key.pem -in cert.pem\n Use with -s (--server-mode) option or with manually specified TLS overlays.\n See moreexamples.md for more info.\n --pkcs12-passwd Password for --pkcs12-der pkcs12 archive. Required on Mac.\n --restrict-uri \n When serving a websocket, only accept the given URI, like `/ws`\n This liberates other URIs for things like serving static files or proxying.\n -F, --static-file ...\n Serve a named static file for non-websocket connections.\n Argument syntax: ::\n Argument example: /index.html:text/html:index.html\n Directories are not and will not be supported for security reasons.\n Can be specified multiple times. Recommended to specify them at the end or with equal sign like `-F=...`,\n otherwise this option may eat positional arguments\n\n\n --protocol Specify this Sec-WebSocket-Protocol: header when connecting\n --server-protocol \n Force this Sec-WebSocket-Protocol: header when accepting a connection\n\n --websocket-version Override the Sec-WebSocket-Version value\n --ping-interval Send WebSocket pings each this number of seconds\n --ping-timeout \n Drop WebSocket connection if Pong message not received for this number of seconds\n\n\nARGS:\n In simple mode, WebSocket URL to connect. In advanced mode first address (there are many kinds of\n addresses) to use. See --help=types for info about address types. If this is an address for\n listening, it will try serving multiple connections.\n In advanced mode, second address to connect. If this is an address for listening, it will accept only\n one connection.\n\n\nBasic examples:\n Command-line websocket client:\n websocat ws://echo.websocket.org/\n \n WebSocket server\n websocat -s 8080\n \n WebSocket-to-TCP proxy:\n websocat --binary ws-l:127.0.0.1:8080 tcp:127.0.0.1:5678\n \n\nPartial list of address types:\n\tws:// \tInsecure (ws://) WebSocket client. Argument is host and URL.\n\twss:// \tSecure (wss://) WebSocket client. Argument is host and URL.\n\tws-listen: \tWebSocket server. Argument is host and port to listen.\n\twss-listen: \tListen for secure WebSocket connections on a TCP port\n\tstdio: \tSame as `-`. Read input from console, print to console.\n\ttcp: \tConnect to specified TCP host and port. Argument is a socket address.\n\ttcp-listen: \tListen TCP port on specified address.\n\tssl-listen: \tListen for SSL connections on a TCP port\n\tsh-c: \tStart specified command line using `sh -c` (even on Windows)\n\tcmd: \tStart specified command line using `sh -c` or `cmd /C` (depending on platform)\n\treadfile: \tSynchronously read a file. Argument is a file path.\n\twritefile: \tSynchronously truncate and write a file.\n\tappendfile: \tSynchronously append a file.\n\tudp: \tSend and receive packets to specified UDP socket, from random UDP port \n\tudp-listen: \tBind an UDP socket to specified host:port, receive packet\n\tmirror: \tSimply copy output to input. No arguments needed.\n\tliteralreply: \tReply with a specified string for each input packet.\n\tliteral: \tOutput a string, discard input.\nPartial list of overlays:\n\tbroadcast: \tReuse this connection for serving multiple clients, sending replies to all clients.\n\tautoreconnect: \tRe-establish underlying connection on any error or EOF\n```\n\nPre-built binaries for Linux (usual and musl), Windows, OS X and Android are available on the [releases page](https://github.com/vi/websocat/releases).\n\nLimitations\n---\n\n* Websocat can't mix sending text and binary WebSocket messages. This also affects `mirror:` specifier, making it a bit different from ws://echo.websocket.org.\n* Current version of Websocat don't receive notification about closed sockets. This makes serving without `-E` or `-u` options or in backpressure scenarios prone to socket leak.\n\nBuilding from source code\n---\n\n1. Install the [Rust toolchain](https://rustup.rs/)\n2. `cargo build --release --features=ssl`.\n3. Find the executable somewhere under `target/`, e.g. in `target/release/websocat`.\n\n\nSSL on Android\n---\n\nwebsocat's `wss://` may fail on Android. As a workaround, download certificate bundle, for example, from https://curl.haxx.se/ca/cacert.pem and specify it explicitly:\n\n SSL_CERT_FILE=cacert.pem /data/local/tmp/websocat wss://echo.websocket.org\n\nOr just use `--insecure` option.\n\nReference\n---\n\nThere is a work-in-progress [reference document](doc.md) that contains more options and examples.\n\nSome notes\n---\n\n* It runs singlethreaded, but can serve multiple connections simultaneously. There is old non-async threaded version in `legacy` branch of releases prior to 0.5.\n* IPv6 is supported, surround your IP in square brackets or use it as is, depending on context.\n* Web socket usage is not obligatory, you can use any specs on both sides.\n* Typically one line in binary stream correspond to one WebSocket text message. This is adjustable with options.\n\nPlanned features\n---\n\nThere are also checkboxes on issues [#1](https://github.com/vi/websocat/issues/1) and [#5](https://github.com/vi/websocat/issues/5).\n\nSee also\n---\n\n* [wstunnel](https://github.com/erebe/wstunnel)\n* [wscat](https://github.com/websockets/wscat)\n* [websocketd](https://github.com/joewalnes/websocketd)\n* [wsd](https://github.com/alexanderGugel/wsd)\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",25524345,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",359316,"full_size",25521060,"id",59186693,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:902f0b3a263fd274fc1acf24e95c7226071075b42775894205285fd894188120","features","","last_pulled","2026-09-24T22:25:22.450167604Z","last_pushed","2019-06-18T09:16:48Z","os","linux","os_features","os_version","size","variant","2019-06-18T09:16:47.344345Z","last_updater","last_updater_username","media_type","latest","repository",7280542,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":136,"_143":144,"_132":153,"_154":11},{"_36":137,"_38":138,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":139,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":140,"_75":11,"_76":142,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":141},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_145":60,"_146":-5,"_147":-5,"_148":149},"count","next","previous","results",[150],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":151,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[152],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

solsson/websocat

Tags for solsson/websocat