CLI

CLI
goloop
Description
Goloop CLI
Usage
goloop
Child commands
Command
Description
​goloop chain​
Manage chains
​goloop debug​
DEBUG API
​goloop gn​
Genesis transaction manipulation
​goloop gs​
Genesis storage manipulation
​goloop ks​
Keystore manipulation
​goloop rpc​
JSON-RPC API
​goloop server​
Server management
​goloop stats​
Display a live streams of chains metric-statistics
​goloop system​
System info
​goloop user​
User management
​goloop version​
Print goloop version
goloop chain
Description
Manage chains
Usage
goloop chain TASK CID PARAM
Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
Child commands
Command
Description
​goloop chain backup​
Start to backup the channel
​goloop chain config​
Configure chain
​goloop chain genesis​
Download chain genesis file
​goloop chain import​
Start to import legacy database
​goloop chain inspect​
Inspect chain
​goloop chain join​
Join chain
​goloop chain leave​
Leave chain
​goloop chain ls​
List chains
​goloop chain prune​
Start to prune the database based on the height
​goloop chain reset​
Chain data reset
​goloop chain start​
Chain start
​goloop chain stop​
Chain stop
​goloop chain verify​
Chain data verify
goloop chain backup
Description
Start to backup the channel
Usage
goloop chain backup CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain config
Description
Configure chain
Usage
goloop chain config CID KEY VALUE
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain genesis
Description
Download chain genesis file
Usage
goloop chain genesis CID FILE
Inherited Options
goloop chain import
Description
Start to import legacy database
Usage
goloop chain import CID [flags]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--db_path
​
true
​
Database path
--height
​
true
0
Block Height
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain inspect
Description
Inspect chain
Usage
goloop chain inspect CID [flags]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--format, -f
​
false
​
Format the output using the given Go template
--informal
​
false
false
Inspect with informal data
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain join
Description
Join chain
Usage
goloop chain join [flags]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--auto_start
​
false
false
Auto start
--channel
​
false
​
Channel
--concurrency
​
false
1
Maximum number of executors to be used for concurrency
--db_type
​
false
goleveldb
Name of database system(*badgerdb, goleveldb, boltdb, mapdb)
--default_wait_timeout
​
false
0
Default wait timeout in milli-second (0: disable)
--genesis
​
false
​
Genesis storage path
--genesis_template
​
false
​
Genesis template directory or file
--max_block_tx_bytes
​
false
0
Max size of transactions in a block
--max_wait_timeout
​
false
0
Max wait timeout in milli-second (0: uses same value of default_wait_timeout)
--node_cache
​
false
none
Node cache (none,small,large)
--normal_tx_pool
​
false
0
Size of normal transaction pool
--patch_tx_pool
​
false
0
Size of patch transaction pool
--platform
​
false
​
Name of service platform
--role
​
false
3
[0:None, 1:Seed, 2:Validator, 3:Both]
--secure_aeads
​
false
chacha,aes128,aes256
Supported Secure AEAD with order (chacha,aes128,aes256) - Comma separated string
--secure_suites
​
false
none,tls,ecdhe
Supported Secure suites with order (none,tls,ecdhe) - Comma separated string
--seed
​
false
​
List of trust-seed ip-port, Comma separated string
--tx_timeout
​
false
0
Transaction timeout in milli-second (0: uses system default value)
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain leave
Description
Leave chain
Usage
goloop chain leave CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain ls
Description
List chains
Usage
goloop chain ls
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain prune
Description
Start to prune the database based on the height
Usage
goloop chain prune CID [flags]
Options
Name,shorthand
Environment Variable
Required
Default
Description
--db_type
​
false
​
Database type(default:original database type)
--height
​
true
0
Block Height
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain reset
Description
Chain data reset
Usage
goloop chain reset CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain start
Description
Chain start
Usage
goloop chain start CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain stop
Description
Chain stop
Usage
goloop chain stop CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop chain verify
Description
Chain data verify
Usage
goloop chain verify CID
Inherited Options
Name,shorthand
Environment Variable
Required
Default
Description
--config, -c
​
false
​
Parsing configuration file
--key_store
​
false
​
KeyStore file for wallet
--node_dir
​
false
​
Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s
​
true
​
Node Command Line Interface socket path(default:[node_dir]/cli.sock)
goloop debug
Description
DEBUG API
Usage
goloop debug
Options
Name,shorthand
Environment Variable
Required
Default
Description
--uri
GOLOOP_DEBUG_URI
true
​
URI of DEBUG API
Child commands

Command	Description
goloop chain	Manage chains
goloop debug	DEBUG API
goloop gn	Genesis transaction manipulation
goloop gs	Genesis storage manipulation
goloop ks	Keystore manipulation
goloop rpc	JSON-RPC API
goloop server	Server management
goloop stats	Display a live streams of chains metric-statistics
goloop system	System info
goloop user	User management
goloop version	Print goloop version

Name,shorthand	Required	Description
--config, -c	false	Parsing configuration file
--key_store	false	KeyStore file for wallet
--node_dir	false	Node data directory(default:[configuration file path]/.chain/[ADDRESS])
--node_sock, -s	true	Node Command Line Interface socket path(default:[node_dir]/cli.sock)

Command	Description
goloop chain backup	Start to backup the channel
goloop chain config	Configure chain
goloop chain genesis	Download chain genesis file
goloop chain import	Start to import legacy database
goloop chain inspect	Inspect chain
goloop chain join	Join chain
goloop chain leave	Leave chain
goloop chain ls	List chains
goloop chain prune	Start to prune the database based on the height
goloop chain reset	Chain data reset
goloop chain start	Chain start
goloop chain stop	Chain stop
goloop chain verify	Chain data verify

Name,shorthand	Environment Variable	Required	Default	Description
--format, -f		false		Format the output using the given Go template
--informal		false	false	Inspect with informal data

Name,shorthand	Required	Default	Description
--auto_start	false	false	Auto start
--channel	false		Channel
--concurrency	false	1	Maximum number of executors to be used for concurrency
--db_type	false	goleveldb	Name of database system(*badgerdb, goleveldb, boltdb, mapdb)
--default_wait_timeout	false	0	Default wait timeout in milli-second (0: disable)
--genesis	false		Genesis storage path
--genesis_template	false		Genesis template directory or file
--max_block_tx_bytes	false	0	Max size of transactions in a block
--max_wait_timeout	false	0	Max wait timeout in milli-second (0: uses same value of default_wait_timeout)
--node_cache	false	none	Node cache (none,small,large)
--normal_tx_pool	false	0	Size of normal transaction pool
--patch_tx_pool	false	0	Size of patch transaction pool
--platform	false		Name of service platform
--role	false	3	[0:None, 1:Seed, 2:Validator, 3:Both]
--secure_aeads	false	chacha,aes128,aes256	Supported Secure AEAD with order (chacha,aes128,aes256) - Comma separated string
--secure_suites	false	none,tls,ecdhe	Supported Secure suites with order (none,tls,ecdhe) - Comma separated string
--seed	false		List of trust-seed ip-port, Comma separated string
--tx_timeout	false	0	Transaction timeout in milli-second (0: uses system default value)

Name,shorthand	Environment Variable	Required	Default	Description
--db_type		false		Database type(default:original database type)
--height		true	0	Block Height