Categorygithub.com/consensus-network/consensusdcmdconsensusctl
package
1.0.0
Repository: https://github.com/consensus-network/consensusd.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
15
Dependents
0
Files
461 SLOC

# README

consensusctl

consensusctl is an RPC client for consensusd.

Requirements

Go 1.19 or later.

Build from Source

  • Install Go according to the installation instructions here: http://golang.org/doc/install

  • Ensure Go was installed properly and is a supported version:

go version
  • Run the following commands to obtain and install consensusd including all dependencies:
git clone https://github.com/consensus-network/consensusd
cd consensusd/cmd/consensusctl
go install .
  • consensusctl should now be installed in $(go env GOPATH)/bin. If you did not already add the bin directory to your system path during Go installation, you are encouraged to do so now.

Usage

The full consensusctl configuration options can be seen with:

consensusctl --help

But the minimum configuration needed to run it is:

consensusctl <REQUEST_JSON>

For example:

consensusctl '{"getBlockDagInfoRequest":{}}'

For a list of all available requests check out the RPC documentation