hsg v0.1.0

hsg

CLI tool for message encoding/decoding

Installation

npm install -g hsg

Build from source

// Node version: v11.14.0+
// NPM version: v6.7.0
npm run build
npm install -g .

Start up instruction

1. Download data protocol binary here
2. Follow instructions here to start the data protocol daemon
3. Navigate to the directory you wish to use to store guilds data and run hsg init to initialize the directory
4. Run hsg config --host 127.0.0.1 --port 9098

To create and push a new guild to the network

1. hsg make guild <name> to make a new guild subdirectory
2. Edit /guilds/<name>/guild.json and /guilds/<name>/guild.md
3. Add your name and private key by running hsg config --tld <tld> --privateKey <pk>
4. hsg push <name>

To fetch and read a guild

1. hsg fetch <name> to fetch latest content from network
2. hsg whois <name> to output guild data

Usage

Usage: hsg [options] [command]

Options:
  -v, --version           output the current version
  -h, --help              display help for command

Commands:
  init                    initialize current directory
  list                    list guilds in directory
  make                    make new sub-directory
  whois <tld>             print details of a guild
  export <tld>            export guild data serialized in hex
  import <tld> <hexdata>  import guild hex data
  status <tld>
  config [options]        set configurations
  fetch [tld]             fetch content from one or all tlds
  push [options] <tld>    push content from a tld
  help [command]          display help for command