Skip to content

holepunchto/blind-peer-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Blind Peer CLI

CLI for running blind peers.

Installation

Install globally to use the blind-peer command:

npm install -g blind-peer-cli

Usage

Run a blind peer:

blind-peer

Or, to run on bare:

blind-peer-bare

Command Line Options

  • --storage|-s [path] - Storage path, defaults to ./blind-peer
  • --port|-p [int] - DHT Port to try to bind to. Only relevant when that port is not firewalled. (defaults to a random port)
  • --trusted-peer|-t [trusted-peer] - Public key of a trusted peer (allowed to set announce: true). Can be specified multiple times.
  • --debug|-d - Enable debug mode (more logs). Can be specified multiple times.
  • --max-storage|-m [int] - Max storage usage, in Mb (defaults to 100000)
  • --autodiscovery-rpc-key [autodiscovery-rpc-key] - Public key where the autodiscovery service is listening. When set, the autodiscovery-seed must also be set. Can be hex or z32.
  • --autodiscovery-seed [autodiscovery-seed] - 64-byte seed used to authenticate to the autodiscovery service. Can be hex or z32.
  • --autodiscovery-service-name [autodiscovery-service-name] - Name under which to register the service (default blind-peer)
  • --scraper-public-key [scraper-public-key] - Public key of a dht-prometheus scraper. Can be hex or z32.
  • --scraper-secret [scraper-secret] - Secret of the dht-prometheus scraper. Can be hex or z32.
  • --scraper-alias [scraper-alias] - (optional) Alias with which to register to the scraper

Output

When started, ndjson (pino) will be emitted for events. An example startup will look like:

{"level":30,"time":1751662694931,"pid":96069,"hostname":"L293","msg":"Starting blind peer"}
{"level":30,"time":1751662694932,"pid":96069,"hostname":"L293","msg":"Using storage 'blind-peer'"}
{"level":30,"time":1751662696936,"pid":96069,"hostname":"L293","msg":"Blind peer listening, local address is 10.0.0.214:49741"}
{"level":30,"time":1751662696936,"pid":96069,"hostname":"L293","msg":"Bytes allocated: 0B of 100GB"}
{"level":30,"time":1751662696936,"pid":96069,"hostname":"L293","msg":"Listening at es4n7ty45odd1udfqyi9xz58mrbheuhdnxgdufsn9gz6e5uhsqco"}
{"level":30,"time":1751662696936,"pid":96069,"hostname":"L293","msg":"Encryption public key is ur7d9r7s3zf1ryibixt5139bep67y94s5bg4gckzo1p6qgtwwfyy"}

About

CLI for running a blind peer

Resources

License

Stars

Watchers

Forks

Packages

No packages published