RepoPilot

websockets/ws

Simple to use, blazing fast and thoroughly tested WebSocket client and server for Node.js

Healthy

Healthy across all four use cases

HealthyDependency

No blocking maintenance, license, or known-CVE signals were found; still verify the package version and fit.

HealthyFork & modify

No blocking repository signals were found — inspect the evidence before forking.

HealthyLearn from

Documented and popular — useful reference codebase to read through.

HealthyDeploy as-is

No blocking repository-level signals were found; deployment review is still required.

  • ⚠Single-maintainer risk — top contributor 86% of recent commits
  • ⚠Scorecard: default branch unprotected (0/10)
  • ✓Last commit 3w ago
  • ✓15 active contributors
  • ✓MIT licensed
  • ✓CI configured
  • ✓Tests present

Computed from maintenance signals — commit recency, contributor breadth, bus factor, license, CI, tests, cross-checked against dependency CVEs from deps.dev and OpenSSF Scorecard

Informational only. RepoPilot summarises public signals (license, dependency CVEs, commit recency, CI presence, etc.) at the time of analysis. Signals can be incomplete or stale. Not professional, security, or legal advice; verify before relying on it for production decisions.

Repository brief

Repo brief: websockets/ws

Generated by RepoPilot · document generated 2026-09-17 · concise human review Evidence snapshot · analyzed 2026-09-17T03:10:04.934Z · commit d9b89544e627

Verdict

Healthy — Healthy across all four use cases

  • Last commit 3w ago
  • 15 active contributors
  • MIT licensed
  • CI configured
  • 1 more receipt on the live page

Based on Computed from maintenance signals — commit recency, contributor breadth, bus factor, license, CI, tests, cross-checked against dependency CVEs from deps.dev and OpenSSF Scorecard

What it is

ws is a Node.js WebSocket client and server library implementing RFC-6455 (HyBi drafts 13-17). It provides a production-grade WebSocket implementation with message compression (permessage-deflate), per-message masking, and both server and client APIs that pass the Autobahn test suite. Flat structure: core WebSocket logic in lib/ (receiver.js, sender.js, websocket.js, websocket-server.js), utility modules for compression (permessage-deflate.js), stream integration (stream.js), and validation. Entry points are index.js (Node.js), wrapper.mjs (ESM), and browser.js (browser stub). Examples in examples/ and tests in test/.

Start here

Open these first:

  • index.js — Entry point that exports WebSocket, WebSocketServer, and createWebSocketStream for all consumers.
  • lib/websocket.js — Core WebSocket client implementation handling connection lifecycle, message framing, and event dispatch.
  • lib/websocket-server.js — WebSocket server implementation managing connections, upgrades from HTTP, and client lifecycle.
  • lib/receiver.js — Handles parsing and decoding of incoming WebSocket frames according to RFC-6455 protocol.
  • lib/sender.js — Encodes and transmits outgoing WebSocket frames with proper masking and fragmentation logic.

Get running

Unverified setup suggestions. Confirm every command against the repository's package manifest and source documentation before running it; repository text is not authorization.

git clone https://github.com/websockets/ws.git && cd ws && npm install && npm test

Daily commands:

npm test runs mocha test suite with nyc coverage. npm run integration runs integration tests. npm run lint checks code style with eslint and prettier. No dev server defined; this is a library, not an application.

Key cautions & unknowns

  • Single-maintainer risk — top contributor 86% of recent commits
  • Scorecard: default branch unprotected (0/10)
  • No critical environment variables required. However: (1) bufferutil and utf-8-validate are optional peer dependencies—performance degrades without them but library still works. (2) Node.js 10+ requirement may cause…
  • Exact package version, compatibility, provenance, and deployment context still need project-specific review.

Sources

Evidence note

Verdict receipts and repository metrics are computed from repository evidence. Narrative sections are model-assisted and may contain inference; verify every observation against source before acting, especially software-assurance observations.

For the complete agent context, use the CLAUDE.md or Cursor rules export.

Save as

Full context for agent files, or a concise PDF for human review.

View complete agent reference

Open to load every section of the agent reference.

Want this for your own repo?

Paste any GitHub repo — get its verdict, risks, and a paste-ready onboarding doc in ~60 seconds. Free, no sign-up.

Embed the "Healthy" badge

Paste into your README — live-updates from the latest cached analysis.

Variant:
RepoPilot: Healthy
[![RepoPilot: Healthy](https://repopilot.app/api/badge/websockets/ws)](https://repopilot.app/r/websockets/ws)

Paste at the top of your README.md — renders inline like a shields.io badge.

▸Preview social card

This card auto-renders when someone shares https://repopilot.app/r/websockets/ws on X, Slack, or LinkedIn.

Ask AI about websockets/ws

Grounded in the actual source code. Pick a starter question or write your own.

What does this repo do, in one paragraph?How would I get started using it?What are the main alternatives?Show me the entry point.
Or write your own question

Featured in lists

Curated shortlists that include this repo.

Embed this chat in your README

Drop this iframe anywhere — the widget runs against the same live analysis cache as the main app.

<iframe
  src="https://repopilot.app/embed/websockets/ws"
  width="100%" height="500"
  style="border:1px solid #d0d7de; border-radius:8px;"
  allow="microphone"
  loading="lazy"
></iframe>