kaspactl

README

kaspactl

kaspactl is an RPC client for kaspad

Requirements

Go 1.19 or later.

Installation

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 kaspad including all dependencies:

$ git clone https://github.com/coinexcom/kaspad
$ cd kaspad/cmd/kaspactl
$ go install .

• Kaspactl 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 kaspctl configuration options can be seen with:

$ kaspctl --help

But the minimum configuration needed to run it is:

$ kaspactl <REQUEST_JSON>

For example:

$ kaspactl '{"getBlockDagInfoRequest":{}}'

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