Case study

github-websocket-pipelines-api: probing GitHub Actions live-log messages

github-websocket-pipelines-api probes GitHub Actions' undocumented live-log WebSocket interface. Its TypeScript client finds an in-progress run, obtains a socket URL through GitHub's live-log endpoints, sends a JSON handshake and WatchRunAsync request with a record separator, and prints incoming messages.

Targets: Protocol · Website
Category: Independent reconstruction cases
Relationship: Independent reconstruction project
Sources reviewed: 2026-11-07

Stars: 4
Last commit: 2022-11-04
Language: TypeScript

GitHub data as of 2026-11-09

Copy as Markdown View JSON Cite

Requirements & limits

Prerequisites: A USER_SESSION environment value is required by the client.
Scope: The example is fixed to a user and repository in client.ts and looks for an in-progress Actions run.
License: MIT license is declared in package.json.

Cite

BibTeX

@misc{github-websocket-pipelines-api-case,
  title = {{github-websocket-pipelines-api: probing GitHub Actions live-log messages}},
  howpublished = {\url{https://github.com/Hacksore/github-websocket-pipeline-api}},
  url = {https://github.com/Hacksore/github-websocket-pipeline-api},
  urldate = {2026-11-07},
  note = {Awesome REA entry: \url{https://awesomerea.org/resources/github-websocket-pipelines-api-case/}}
}

Plain text

github-websocket-pipelines-api: probing GitHub Actions live-log messages. https://github.com/Hacksore/github-websocket-pipeline-api (accessed 2026-11-07). Awesome REA entry: https://awesomerea.org/resources/github-websocket-pipelines-api-case/

Useful? Star Awesome REA on GitHub2.4k

About this entry

The description was reviewed against primary sources.

Report an outdated entry Suggest a translation fix

Primary sources

client.ts GitHub · Hacksore/github-websocket-pipeline-api · Revision ab13b29
README.md GitHub · Hacksore/github-websocket-pipeline-api · Revision ab13b29
package.json GitHub · Hacksore/github-websocket-pipeline-api · Revision ab13b29