cerc-io/watcher-ts
16
1
Fork 0
mirror of https://github.com/cerc-io/watcher-ts synced 2024-11-20 04:46:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
6a8b9a2385
watcher-ts/packages/cli/README.md
prathamesh0 e47f864966
Add an option to use a domain name for a announce address (#320) 
* Add an option to use a domain name for a announce address

* Update chat CLI readme

* Set port range for relay node

* Add descriptive comment

* Upgrade webrtc-direct version
2023-02-15 18:09:21 +05:30

1.2 KiB
Raw Blame History

cli

chat

A basic CLI to pass messages between peers using stdin/stdout

  • Install dependencies:

    yarn install

  • Build the peer package:

    cd packages/peer
yarn build

  • (Optional) Create and export a peer id for the relay node:

    # In packages/peer
yarn create-peer --file [PEER_ID_FILE_PATH]
    • file (f): file path to export the peer id to (json) (default: logs to console)

  • (Optional) Run a local relay node:

    # In packages/peer
yarn relay-node --host [LISTEN_HOST] --port [LISTEN_PORT] --announce [ANNOUNCE_DOMAIN] --peer-id-file [PEER_ID_FILE_PATH] --relay-peers [RELAY_PEERS_FILE_PATH]
    • host (h): host to bind to (default: 127.0.0.1)
    • port (p): port to start listening on (default: 9090)
    • announce (a): domain name to be used in the announce address
    • peer-id-file (f): file path for peer id to be used (json)
    • relay-peers (r): file path for relay peer multiaddr(s) to dial on startup (json)

  • Start the node:

    # In packages/cli
yarn chat --relay-node <RELAY_NODE_URL>
    • relay-node: multiaddr of a primary hop enabled relay node

  • The process starts reading from stdin and outputs messages from others peers to stdout.