websocat's toolchain table has a duplicated row and eight question marks
Command-line client for WebSockets, like netcat (or curl) for ws:// with advanced socat-like functions
At a glance
- What is it?
- websocat is a command-line client that treats WebSocket as one specifier among many, in the spirit of netcat and socat. Its readme is unusually frank about building it. There is a table mapping each release line to a minimum and maximum compiler version, and six of the eight rows have question marks in the maximum column, one row is listed twice with different answers, and the row covering the current stable line has no numbers at all. The build instructions then tell you not to use a compiler newer than a named version.
- Who is it for?
- websocat fits someone debugging a WebSocket endpoint from a terminal, bridging it to a TCP port, a Unix socket or an external program, and who is content to use a prebuilt binary for the operating system they are on. It does not fit someone who needs to reach a server that only offers an HTTP/2 or HTTP/3 upgrade, since neither is supported and there is no option that changes it.
- Can I use it commercially?
- Yes. MIT is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
- Is it still maintained?
- Yes. The repository last received commits 1 day ago.
- What is it written in?
- Mainly Rust, according to GitHub's language statistics.
Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.
Star history
- vi/websocat8,757 ★ · +62
| Repository | 2026-09-22 | 2026-11-15 |
|---|---|---|
| vi/websocat | 8.7k | 8.8k |
62 Stars in the last 54 days, measured from the daily GitHub snapshot. Compare with other projects
Editorial analysis
The toolchain table has a duplicated row and four question marks
The build section includes a table with a row per release line and columns for the minimal and maximal compiler version. Six of the eight rows end their maximum with a question mark. One version appears twice, once with a minimum and a guessed maximum and once with question marks in both. And the row covering the current stable line and everything after it has question marks in both columns:
| 1.12+ | ? | ? |
Consequence: the table cannot tell you which compiler to use for the version you would actually build. The rows that are populated are for versions old enough to be irrelevant, and the one that matters is empty. The prose below the table then says it may not be a good idea to build the stable line with a compiler newer than a named version, and that the author last checked it properly a long time ago. So the honest answer to which compiler should I use is: the repository does not know. The table also stops at the first alpha of the four series, giving only a minimum of 1.84 for it and nothing for later alphas, and the note about early non-async versions being buildable by even older compilers sits below the table like an afterthought.
Two lockfiles and a manual step to choose between them
The repository has a lockfile and a second one with a legacy suffix, and the build notes say that building with an older compiler may require manually copying the legacy one over the other before building. Consequence: there is a step in the instructions that no tool performs for you and that is easy to miss, and a build that fails on a dependency version has a documented fix that reads like folklore. It is a reasonable accommodation for a project whose readme describes its dependencies as old, and it is the sort of instruction that ends up in a wiki rather than in a script. Both lockfiles are at the top of the repository next to the manifest, so choosing the wrong one is a file you can see and have ignored.
The packaging metadata asks for an OpenSSL runtime that has been retired
The manifest carries Debian packaging metadata, and the dependency line is written out by hand:
depends = "libssl1.1, libc6 (>= 2.19), libgcc1 (>= 1:4.9.0)"Consequence: it names a specific major version of the TLS library that current distributions no longer ship, and the adjacent line for automatic dependencies is commented out, so this list is maintained manually. There is also a separate Debian container definition at the top of the repository, which means the packaging is worked on here even though the readme says the tool is not officially packaged for that distribution. Two statements that look contradictory until you notice they are about different things. The extended description in the same block describes the tool as interconnecting two specifiers, so the packaging and the readme describe the same program in the same terms, which makes the runtime dependency the odd one out.
No HTTP/2 and no HTTP/3
The limitations section is short and the first line is the important one. It only connects to, or serves, the first version of HTTP, and both RFCs that define carrying WebSocket over the two later HTTP versions are listed as not currently supported. Consequence: a server that offers only an HTTP/2 upgrade is unreachable, and there is no option that changes this. It is the kind of limit that is fine for a debugging tool and a problem for anything that has to sit in front of a modern reverse proxy, and the readme states it plainly rather than leaving you to discover it on a connection that hangs. The second limitation is about framing rather than transport, and names two prefix options and an encoding option as partial workarounds.
The published package omits the two documents the readme points you at
The manifest lists what goes into the published archive, and it is four entries: the source, the manifest, the licence and the readme. The readme's documentation section points you at a file of further examples and at a file listing every address type and overlay. Consequence: an installed copy links to two documents it did not ship, so the extra examples are only available from a clone. For a tool whose documentation is mostly examples, that is a meaningful gap in what a package user can read. The readme itself is included, so the front-page examples travel with the package and the ones that need more room do not.
The container pins a recent compiler and the prose warns against one
The container definition builds with a specific recent Rust release on a pinned base, and passes a set of features to the build. The readme says the stable line may fail with too new a compiler because of its old dependencies, and separately that building the stable line with a compiler past a named older version may expose undefined behaviour in those dependencies, adding that in practice it seems to work. Consequence: the two places in the repository that name a compiler point in opposite directions and neither is marked authoritative. The container is the one that demonstrably works today, and it is also the one the readme does not describe. The container also builds a placeholder program before the real build, one that prints "if you see this, the build broke" if it ever ends up as the shipped binary, and then removes the placeholder artefacts before copying in the real source.
WebSocket is one specifier and the documentation is a list of specifiers
The notes say WebSocket usage is not obligatory and that you can use any specs on both sides, and the feature list follows from that: an inetd mode, Unix sockets including abstract namespaced ones on Linux, integration with a web server over TCP or Unix sockets, unauthenticated SOCKS5 for connecting and listening, and a mode where an external program serves as the underlying transport. Consequence: the tool interconnects two specifiers, like socat, with WebSocket as only one of them, which is why the documentation is a list of address types and overlays rather than a list of options. One stated limitation is about framing: mixing text and binary messages is called out as inconvenient, which affects the mirror specifier.
One of the four front-page examples points at a different repository
The examples are five blocks. The fourth bridges a TCP port and a WebSocket in both directions. The fifth broadcasts between clients, and carries a note saying that if you like that one you may actually want a different repository instead. Consequence: the author is telling you his own tool is not the right tool for one of the five things he demonstrates, which is more candid than most projects manage and also means a reader who picks the broadcast use case ends up somewhere else. It is the clearest signal in the repository that the specifier system is the product and that individual topologies have better homes. Another block opens a Chromium tab through its remote debugging interface.
Editorial conclusion
websocat fits someone debugging a WebSocket endpoint from a terminal, bridging it to a TCP port, a Unix socket or an external program, and who is content to use a prebuilt binary for the operating system they are on. It does not fit someone who needs to reach a server that only offers an HTTP/2 or HTTP/3 upgrade, since neither is supported and there is no option that changes it. It also does not fit a reproducible source build on a current toolchain, because the repository's own guidance about which compiler to use is incomplete and partly negative. Before building it yourself, use the prebuilt binary, and if you must build, read the toolchain table and the notes under it before choosing a compiler.
Frequently asked questions
how to install websocat
There are several routes and the readme orders them from easiest to hardest. One package manager on FreeBSD, Homebrew or MacPorts on macOS, prebuilt executables from the releases page for Linux, Windows, macOS and Android, and two ways from source, one through the package manager's install command and one through a release build. Debian and Ubuntu are not covered by a package, so the readme points at a prebuilt executable.
how to use websocat
Give it a WebSocket address to connect to, or a port to serve on. Both sides of the connection take a specifier rather than a URL, so you can put a WebSocket on one side and a TCP port, a Unix socket or an external program on the other. The examples at the top of the readme cover echoing, serving, bridging and broadcasting, and a longer set lives in a separate examples file.
websocat vs socat
The readme positions the tool as the three of them together for one protocol: netcat and curl for WebSockets, plus socat-style functions. Where it differs from socat is that WebSocket is optional rather than required, since any specifier can appear on either side of the connection.
Is WebSocket just HTTP?
Close enough that the readme flags it as a limitation rather than an explanation: the tool only speaks the first version of HTTP, and the two RFCs that carry WebSocket over the later HTTP versions are listed as unsupported. That also means a server offering only an HTTP/2 upgrade cannot be reached through it.
how to install websocat on windows
From a prebuilt executable on the releases page, which is also what the readme recommends for Linux and Debian-based systems. There is no package manager route for Windows in the instructions, and secure WebSocket connections on Android are called out as needing an explicit certificate file or an insecure flag.
Official sources
Add this badge to your README
If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.
[](https://hysenlabs.com/projects/vi-websocat)Star history chart for your README
[](https://hysenlabs.com/projects/vi-websocat)Was this useful?