snakepipe
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

snake-pipe-node

npm

A partial node implementation of my rust cli topheman/snake-pipe-rust.

Prerequisites

  • Node

Install

npm install -g snakepipe # will install snakepipenode

Optional: Install the rust version - it will let you pipe original commands

cargo install snakepipe # will install snakepipe

Usage

This is a partial implementation, for all the commands, see the rust implementation.

Piping

📎 Validate incomming stream

# Without piping to render
snakepipe gamestate|snakepipenode validate

# Piping to render
snakepipe gamestate|snakepipenode validate|snakepipe render

IPC (Inter-process communication)

This node version ships with an implementation of IPS supporting tcp and unix domain sockets, just like in the rust version,

TCP

Open two terminals. snakepipenode tcp-play will expose a process that accepts tcp connections (on port 8050 by default). You can connect to it via netcat (the nc command), that will pipe the tcp stream output to stdout.

Here are a few commands mixing the rust and node versions.

# main terminal
snakepipe gamestate|snakepipenode tcp-play|snakepipe render
# mirroring terminal
nc localhost 8050|snakepipe render # with netcat
snakepipenode tcp-watch|snakepipe render # or with snakepipe itself

Unix domain sockets

Open two terminals. snakepipenode socket-play will expose a unix domain socket (by default on /tmp/snakepipe.sock). You can connect to it via netcat (the nc command), that will pipe the socket stream to stdout.

# main terminal
snakepipe gamestate|snakepipenode socket-play|snakepipe render
# mirroring terminal
nc -U /tmp/snakepipe.sock|snakepipe render # with netcat
snakepipenode socket-watch|snakepipe render # or with snakepipe itself

Usage as a library

npm install snakepipe

See example of usage on topheman/snake-pipe-rust.

Known bugs

  • tty issue when piping from snakepipe gamestate #1

Package Sidebar

Install

npm i snakepipe

Weekly Downloads

5

Version

0.2.0

License

MIT

Unpacked Size

28.5 kB

Total Files

24

Last publish

Collaborators

  • topheman