nkisi

Command line client for linking to Web Agent lanes over the WARP protocol

Usage no npm install needed!

<script type="module">
  import nkisi from 'https://cdn.skypack.dev/nkisi';
</script>

README

Nkisi Command Line Tool

Command line tool for linking to Web Agent lanes over the WARP protocol.

Installation

npm install -g nkisi

Usage

$ nkisi help
Usage: nkisi <command>

Commands:
  link                  stream changes to a lane of a remote node
  sync                  stream the current state and changes to a lane of a remote node
  get                   fetch the current state of a lane of a remote node
  reflect               stream introspection metadata
  help

$ nkisi sync help
Usage: nkisi sync [options] <command>

Options:
  -h, --host <hostUri>  remote host to link
  -n, --node <nodeUri>  remote node to link
  -l, --lane <laneUri>  lane to link
  -f, --format <json|recon> event output format

Commands:
  help

$ nkisi reflect help
Usage: nkisi reflect [options] <command>

Options:
  -e, --edge <edgeUri>  endpoint to introspect
  -m, --mesh <meshUri>? introspect default or specified mesh
  -p, --part <partKey>? introspect default or specified partition
  -h, --host <hostUri>? introspect default or specified host
  -n, --node <nodeUri>  introspect specified node
  -l, --lane <laneUri>  introspect specified lane
  -k, --link            introspect link behavior
  -r, --router          introspect router behavior
      --data            introspect data behavior
      --system          introspect system behavior
      --process         introspect process behavior
  -s, --stats           stream introspection statistics
  -f, --format <json|recon> event output format

Commands:
  log                   stream log events
  help