Add websocat

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>

Author: alexellis

AGENTS.md

@@ -70,6 +70,8 @@ Add a test function in `pkg/get/get_test.go`. **Reference `Test_DownloadFaasCli`
 
 ### Step 4: Download and Verify Every OS/Arch Combination
 
+First test downloading the current OS/arch (no flags needed) i.e. `go run . get TOOL`. And run `file` on the output to verify the type and if it's valid or invalid i.e. a gzip, or a HTML page, or got a non zero exit code.
+
 **MANDATORY**: Download and verify EVERY combination using the `file` command.
 
 ```bash
@@ -87,13 +89,18 @@ For each combination, verify the `file` command output:
 - Darwin arm64: `Mach-O 64-bit arm64 executable`
 - Windows amd64: `PE32+ executable (console) x86-64`
 
-Tools built with rust have `unknown` in their filename, that's OK. If deciding between GNU aka libc or musl, pick the non-musl version.
+Tools built with Rust often have `unknown` in their filename, that's OK. If deciding between GNU aka libc or musl, pick the non-musl version, it might be named "unknown".
 
 **Include the full output of `./hack/test-tool.sh TOOL_NAME` in your PR description.**
 
 ### Step 5: Update Documentation
 
-The README.md file contains instructions for updating itself. Follow the note at the bottom of the "Catalog of CLIs" section: run `go build && ./arkade get --format markdown` to generate the updated table, then replace the existing catalog section.
+The README.md file contains instructions for updating itself. Follow the note at the bottom of the "Catalog of CLIs" section: run `go run . get --format markdown` to generate the updated table, then replace the existing catalog section. Write it to a file in the workspace that you delete after, to avoid needing extra permissions.
+
+There are two tokens in the README.md - replace al text between them with what you've generated.
+
+Start of replaceable block is inside: `<!-- start of tool list -->` and the end is inside: `<!-- end of tool list -->`.
+
 
 ### Step 6: Create Pull Request
 

README.md

@@ -950,9 +950,10 @@ There are 53 apps that you can install on your cluster.
 | [vhs](https://github.com/charmbracelet/vhs)                                  | CLI for recording demos                                                                                                                                           |
 | [viddy](https://github.com/sachaos/viddy)                                    | A modern watch command. Time machine and pager etc.                                                                                                               |
 | [waypoint](https://github.com/hashicorp/waypoint)                            | Easy application deployment for Kubernetes and Amazon ECS                                                                                                         |
+| [websocat](https://github.com/vi/websocat)                                   | Command-line client for WebSockets, like netcat/socat but for WebSockets                                                                                          |
 | [yq](https://github.com/mikefarah/yq)                                        | Portable command-line YAML processor.                                                                                                                             |
 | [yt-dlp](https://github.com/yt-dlp/yt-dlp)                                   | Fork of youtube-dl with additional features and fixes                                                                                                             |
-There are 188 tools, use `arkade get NAME` to download one.
+There are 189 tools, use `arkade get NAME` to download one.
 
 
 <!-- end of tool list -->

pkg/get/get_test.go

@@ -9509,6 +9509,58 @@ func Test_DownloadAge(t *testing.T) {
 	}
 }
 
+func Test_DownloadWebsocat(t *testing.T) {
+	tools := MakeTools()
+	name := "websocat"
+
+	tool := getTool(name, tools)
+
+	const toolVersion = "v1.14.1"
+
+	tests := []test{
+		{
+			os:      "linux",
+			arch:    arch64bit,
+			version: toolVersion,
+			url:     "https://github.com/vi/websocat/releases/download/v1.14.1/websocat.x86_64-unknown-linux-musl",
+		},
+		{
+			os:      "linux",
+			arch:    archARM64,
+			version: toolVersion,
+			url:     "https://github.com/vi/websocat/releases/download/v1.14.1/websocat.aarch64-unknown-linux-musl",
+		},
+		{
+			os:      "darwin",
+			arch:    arch64bit,
+			version: toolVersion,
+			url:     "https://github.com/vi/websocat/releases/download/v1.14.1/websocat.x86_64-apple-darwin",
+		},
+		{
+			os:      "darwin",
+			arch:    archDarwinARM64,
+			version: toolVersion,
+			url:     "https://github.com/vi/websocat/releases/download/v1.14.1/websocat.aarch64-apple-darwin",
+		},
+		{
+			os:      "ming",
+			arch:    arch64bit,
+			version: toolVersion,
+			url:     "https://github.com/vi/websocat/releases/download/v1.14.1/websocat.x86_64-pc-windows-gnu.exe",
+		},
+	}
+	verify := false
+	for _, tc := range tests {
+		got, _, err := tool.GetURL(tc.os, tc.arch, tc.version, verify)
+		if err != nil {
+			t.Fatal(err)
+		}
+		if got != tc.url {
+			t.Errorf("want: %s, got: %s", tc.url, got)
+		}
+	}
+}
+
 func Test_DownloadAgeKeygen(t *testing.T) {
 	tools := MakeTools()
 	name := "age-keygen"

pkg/get/tools.go

@@ -5252,5 +5252,34 @@ codex-{{$arch}}-{{$os}}`,
 https://github.com/openai/codex/releases/download/{{.Version}}/codex-{{$arch}}-{{$os}}{{$ext}}`,
 		})
 
+	tools = append(tools,
+		Tool{
+			Owner:          "vi",
+			Repo:           "websocat",
+			Name:           "websocat",
+			Description:    "Command-line client for WebSockets, like netcat/socat but for WebSockets",
+			BinaryTemplate: `websocat`,
+			URLTemplate: `
+{{$target := ""}}
+{{- if eq .OS "linux" -}}
+	{{- if eq .Arch "x86_64" -}}
+		{{$target = "x86_64-unknown-linux-musl"}}
+	{{ else if eq .Arch "aarch64" -}}
+		{{$target = "aarch64-unknown-linux-musl"}}
+	{{- end -}}
+{{- else if eq .OS "darwin" -}}
+	{{- if eq .Arch "x86_64" -}}
+		{{$target = "x86_64-apple-darwin"}}
+	{{ else if eq .Arch "arm64" -}}
+		{{$target = "aarch64-apple-darwin"}}
+	{{- end -}}
+{{- else if HasPrefix .OS "ming" -}}
+	{{- if eq .Arch "x86_64" -}}
+		{{$target = "x86_64-pc-windows-gnu.exe"}}
+	{{- end -}}
+{{- end -}}
+https://github.com/vi/websocat/releases/download/{{.Version}}/websocat.{{$target}}`,
+		})
+
 	return tools
 }