ataraxia-cli

Command-line client for inspecting Ataraxia networks

Usage no npm install needed!

<script type="module">
  import ataraxiaCli from 'https://cdn.skypack.dev/ataraxia-cli';
</script>

README

ataraxia-cli

npm version Dependencies

Command-cline to help with debugging an Ataraxia network.

Installation

Install via NPM:

npm install -g ataraxia-cli

Usage

Inspecting the network

Inspecting the network can be done with the inspect command. This will show nodes as they become available or unavailable. The command will exit after 5 seconds of no inactivity or after 60 seconds. Use --watch to keep it running.

Example:

$ ataraxia --network nameOfNetwork inspect
  INFO  Joining example as GpTYSnv4AX
 Available  GpJFRewg7q
 Available  GpM2xb78yP

Listen to messages

Listening and printing messages can be done via the listen command.

$ ataraxia --network nameOfNetwork listen
$ ataraxia --network nameOfNetwork listen --exchange counter

Picking networks to join

Option Description
--network networkName Join machine-local network and TCP network using mDNS discovery
--hyperswarm topic Discover peers via the given Hyperswarm topic
--sharedKey key Enable shared-key authentication