nkisi
Version:
Command line client for linking to Web Agent lanes over the WARP protocol
62 lines (49 loc) • 1.71 kB
Markdown
# <a href="https://www.nkisi.com"><img src="https://docs.nkisi.com/readme/hex-icon-67x63.svg"></a> Nkisi Command Line Tool
Command line tool for linking to Web Agent lanes over the WARP protocol.
## Installation
```sh
npm install -g nkisi
```
## Usage
```sh
$ 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
```
```sh
$ 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
```
```sh
$ 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
```