feat: initial commit 🚀

Author: AndrewJo

.gitignore

@@ -0,0 +1,43 @@
+# Binaries
+*.exe
+*.dll
+*.so
+*.dylib
+*.wasm
+
+# Go
+go.sum
+vendor/
+
+# Node
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Build outputs
+dist/
+build/
+*.log
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Test coverage
+*.test
+*.out
+coverage/
+
+# Example build
+example/dist/
+
+# GoReleaser
+dist/

.goreleaser.yaml

@@ -0,0 +1,49 @@
+project_name: sshclient-wasm
+
+before:
+  hooks:
+    - go mod tidy
+    - go mod download
+
+builds:
+  - id: wasm
+    main: ./main.go
+    binary: sshclient.wasm
+    goos:
+      - js
+    goarch:
+      - wasm
+    env:
+      - CGO_ENABLED=0
+    ldflags:
+      - -s -w
+
+archives:
+  - id: wasm-archive
+    format: tar.gz
+    files:
+      - sshclient.wasm
+      - wasm_exec.js
+      - lib/**/*
+      - package.json
+      - README.md
+      - LICENSE
+
+release:
+  github:
+    owner: andrew
+    name: sshclient-wasm
+  prerelease: auto
+
+checksum:
+  name_template: 'checksums.txt'
+
+snapshot:
+  name_template: "{{ incpatch .Version }}-next"
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'

CLAUDE.md

@@ -0,0 +1,106 @@
+# Project: sshclient-wasm
+
+This is a Golang project that builds a WASM client for ssh on the browser.
+
+It uses Golang's [golang.org/x/crypto/ssh package](https://pkg.go.dev/golang.org/x/crypto/ssh) which already implements the SSH client protocol. It also works with servers but this project is focused on building a client that can be used in the browser with WebSockets.
+
+The compiler target is WebAssembly. The build is done with GoReleaser.
+
+It should ultimately be an NPM package that can be imported as an ES module for use in frontend projects like Next.js.
+
+## Architecture
+
+The architecture is transport-agnostic, supporting multiple transport protocols including raw WebSockets and AWS IoT Secure Tunneling. The Transport Translation Layer provides a unified interface for different transport implementations.
+
+```mermaid
+graph TB
+    subgraph "Browser Environment"
+        A["ES Module<br/>(TypeScript)"]
+        B["Transport Translation Layer"]
+        C["WASM Layer<br/>(Go SSH Client)"]
+
+        A --> B
+        B <--> C
+    end
+
+    subgraph "Transport Implementations"
+        D["WebSocket Transport"]
+        E["AWS IoT Secure Tunnel<br/>Transport"]
+        F["Custom Transport<br/>(User-defined)"]
+
+        B --> D
+        B --> E
+        B --> F
+    end
+
+    subgraph "Network Layer"
+        G["Direct WebSocket<br/>Connection"]
+        H["AWS IoT<br/>Secure Tunneling"]
+        I["Custom Protocol<br/>Endpoint"]
+
+        D <--> G
+        E <--> H
+        F <--> I
+    end
+
+    subgraph "Destination"
+        J["SSH Server"]
+
+        G --> J
+        H --> J
+        I --> J
+    end
+
+    style A fill:#0277bd,color:#fff
+    style B fill:#7b1fa2,color:#fff
+    style C fill:#ef6c00,color:#fff
+    style D fill:#388e3c,color:#fff
+    style E fill:#388e3c,color:#fff
+    style F fill:#388e3c,color:#fff
+    style G fill:#d32f2f,color:#fff
+    style H fill:#d32f2f,color:#fff
+    style I fill:#d32f2f,color:#fff
+    style J fill:#424242,color:#fff
+```
+
+### Key Components
+
+1. **ES Module (TypeScript)**: The public API that applications import and use
+2. **Transport Translation Layer**: Bridges JavaScript transports with WASM, handling bidirectional data flow
+3. **WASM Layer**: Go implementation of SSH client protocol using `golang.org/x/crypto/ssh`
+4. **Transport Implementations**:
+   - **WebSocket Transport**: Direct WebSocket connections to SSH servers
+   - **AWS IoT Secure Tunnel Transport**: Implements AWS IoT protocol with frame encoding/decoding
+   - **Custom Transport**: User-definable transport for proprietary protocols
+5. **Network Layer**: The actual network connection (WebSocket, AWS IoT, etc.)
+6. **SSH Server**: The destination SSH server
+
+## Tech Stack
+
+- Languages: Golang, TypeScript
+- Frameworks: Next.js, React
+- Build Tools: GoReleaser, Vite, Pnpm via Corepack
+- Tools: WebSocket
+- Testing: Vitest, GoTest
+- Platforms: Browser
+
+## Project Structure
+
+- `main.go`: The entry point for the Go compiler.
+- `pkg/sshclient/`: The SSH client implementation.
+- `lib/`: The TypeScript/JavaScript bindings.
+- `examples/`: Example applications.
+- `dist/`: The build output.
+- `node_modules/`: The Node.js dependencies.
+- `pnpm-lock.yaml`: The Pnpm lock file.
+- `package.json`: The NPM package configuration.
+- `README.md`: The project README.
+- `LICENSE`: The project license.
+
+## Development
+
+### Prerequisites
+
+- Go 1.23+
+- Node.js 22+
+- Pnpm 10+

Makefile

@@ -0,0 +1,33 @@
+.PHONY: build clean test release dev copy-wasm-support
+
+GOOS = js
+GOARCH = wasm
+GO_BUILD_FLAGS = -ldflags="-s -w"
+
+build: copy-wasm-support
+	GOOS=$(GOOS) GOARCH=$(GOARCH) go build $(GO_BUILD_FLAGS) -o dist/sshclient.wasm main.go
+	mkdir -p public
+	cp dist/sshclient.wasm public/
+	cp dist/wasm_exec.js public/
+
+copy-wasm-support:
+	mkdir -p dist
+	cp "$$(go env GOROOT)/lib/wasm/wasm_exec.js" dist/
+
+clean:
+	rm -rf dist/
+
+test:
+	go test ./...
+
+dev: build
+	cd example && npm install && npm run dev
+
+release:
+	goreleaser release --snapshot --clean
+
+npm-build: build
+	npm run build
+
+npm-publish: npm-build
+	npm publish