Command Line Options

Command options are denoted inside < and > arguments are inside [ and ].

Command	Parameters	Description
connect	[node Id]	Connects the CLI to a running catalyst node. Accepts the node id as defined in the devnet.json file.
getinfo	[node Id]	Returns the node configuration. Accepts the node id as defined in the devnet.json file.
getversion	[node Id]	Returns the node version. Accepts the node id as defined in the devnet.json file.
getmempool	[node Id]	Returns the list of transactions in the memory pool. Accepts the node id as defined in the devnet.json file.
sign	<-m> [text message] <-n> < node ID>	Signs a message and returns the following: - Signature - Public Key - Original Message. Accepts the text message to be signed and the node id as defined in the devnet.json file.
verify	<-m> [text_message] <-s> [signature] -k [public_key] <-n> [node ID]	Verify a message and returns True/False based on the verification result. Accepts the following: - The signed text message - Signature - Public Key - The node id as defined in the devnet.json file.
listpeers	<-n> [node Id]	Returns the list of peer nodes. Accepts the node id as defined in the devnet.json file.
peercount	<-n> [node Id]	Returns the number of peer nodes. Accepts the node id as defined in the devnet.json file.
removepeer	<-n> [node Id] <-k> [Public Key] <-i> [IP Address]	Removes a peer from the list of peers. Accepts the following: - The public key of the peer to be removed - IP address of the peer - The node id as defined in the devnet.json file.
peerrep	<-n> [node Id] <-l> [IP Address] <-p> [Public Key]	Returns the reputation of a peer. Accepts the following: - The public key of the peer to be removed - IP address of the peer - The node id as defined in the devnet.json file.
addfile	<-n> [node Id] <-f> [File Name]	Uploads a file to DFS and returns the following if the file is successfully uploaded: - Response Status: Finished - The DFS hash Otherwise, one of the following responses is returned: - TransferPending - Error - Expired - Failed Accepts the following: - The full qualified name of the file - The node id as defined in the devnet.json file.
getfile	<-n> [node Id] <-f> [DFS Hash] <-o> [Output path]	Gets a file from DFS. Accepts the following: - The full qualified name of the output file - The DFS hash - The node id as defined in the devnet.json file.