Skip to content
This repository was archived by the owner on Aug 12, 2021. It is now read-only.

Commit 2c7721b

Browse files
committed
[skip travis] Update README
1 parent 612c97c commit 2c7721b

1 file changed

Lines changed: 44 additions & 50 deletions

File tree

README.md

Lines changed: 44 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -67,58 +67,52 @@ Run `forge` and get available options and subcommands.
6767
Usage: forge [options] [command]
6868
6969
Options:
70-
-V, --version output the version number
71-
-v, --verbose Output runtime info when execute subcommand, useful for debug
72-
-c, --chain-name <chainName> Execute command use specific chain
73-
-i, --config-path <path> Forge config used when starting forge node and initializing gRPC clients
74-
-r, --npm-registry <registry> Specify a custom npm registry
75-
-y, --yes Assume that the answer to any confirmation question is yes
76-
-d, --defaults Run command using default values for all questions
77-
-m, --mirror <url> Mirror host used to download forge release
78-
-g, --socket-grpc <endpoint> Socket gRPC endpoint to connect, with this you can use forge-cli with a remote node
79-
-h, --help output usage information
70+
-V, --version output the version number
71+
-v, --verbose Output runtime info when execute subcommand, useful for debug
72+
-c, --chain-name <chainName> Execute command use specific chain
73+
-i, --config-path <path> Forge config used when starting forge node and initializing gRPC clients
74+
-r, --npm-registry <registry> Specify a custom npm registry
75+
-y, --yes Assume that the answer to any confirmation question is yes
76+
-d, --defaults Run command using default values for all questions
77+
-m, --mirror <url> Mirror host used to download forge release
78+
-g, --socket-grpc <endpoint> Socket gRPC endpoint to connect, with this you can use forge-cli with a remote node
79+
-h, --help output usage information
8080
8181
Commands:
82-
account <address> Get an account info by address
83-
asset <address> Get asset info by address
84-
block [options] [height] Get the block info from the running node
85-
blocklet:init [options] Init a blocklet project
86-
blocklet:use [options] Download and install a blocklet
87-
chain:config [options] [action] Read/write chain/node config
88-
chain:create [chainName] Create a new chain instance
89-
chain:ls List all chains
90-
chain:remove <chainName> Remove chain state and config
91-
chain:reset <chainName> Reset chain state, but keeps the config
92-
chain:validator [options] Update(add, remove, change) or list validators
93-
config [options] [key] [value] Config forge cli configs
94-
contract:activate [name|address] Activate a contract by name or address
95-
contract:compile [sourceDir] Compile a forge contract
96-
contract:create [options] Create contract files
97-
contract:deactivate [name|address] Deactivate a contract
98-
contract:deploy [itxPath] Deploy a compiled contract to ABT Node
99-
contract:ls List contracts
100-
declare:node [options] Declare the current node to be a validator candidate
101-
deploy:prepare [options] Prepare node for deploying a multi-node chain
102-
download [options] [version] Download a forge release without activate it
103-
help [subcommand] Show help of a sub command
104-
install [options] [version] Download and setup forge release on this machine
105-
join <endpoint> Join a network by providing a valid forge web graphql endpoint
106-
logs [type] Show logs for various forge components
107-
ls List forge releases installed locally
108-
ls:remote List remote forge releases available for install
109-
ps List running forge component processes
110-
remote [shellName] Connects to the running system via a remote shell
111-
simulator [action] Start/stop simulator and generate random traffic
112-
start [options] [<chainName>] Start the forge and forge web deamon
113-
status [type] List info of the running chain/node
114-
stop [options] [<chainName>] Stop the forge daemon and all related services
115-
tx [hash] Get a tx detail and display
116-
tx:ls List latest transactions
117-
upgrade [<chainName>] Upgrade chain node to new version without reset
118-
use [version] Activate an already downloaded forge release
119-
version [<chainName>] Output version for all forge components
120-
wallet:create Create a local wallet and dump its public/private key
121-
web [action] Open the web interface of running forge chain/node
82+
account <address> Get an account info by address
83+
asset <address> Get asset info by address
84+
block [options] [height] Get the block info from the running node
85+
blocklet:init [options] Init a blocklet project
86+
blocklet:use [options] Download and install a blocklet
87+
chain:config [options] [action] Read/write chain/node config
88+
chain:create [chainName] Create a new chain instance
89+
chain:ls List all chains
90+
chain:remove <chainName> Remove chain state and config
91+
chain:reset <chainName> Reset chain state, but keeps the config
92+
chain:validator [options] Update(add, remove, change) or list validators
93+
config [options] [key] [value] Config forge cli configs
94+
declare:node [options] Declare the current node to be a validator candidate
95+
deploy:prepare [options] Prepare node for deploying a multi-node chain
96+
download [options] [version] Download a forge release without activate it
97+
help [subcommand] Show help of a sub command
98+
install [options] [version] Download and setup forge release on this machine
99+
join <endpoint> Join a network by providing a valid forge web graphql endpoint
100+
logs [type] Show logs for various forge components
101+
ls List forge releases installed locally
102+
ls:remote List remote forge releases available for install
103+
ps List running forge component processes
104+
remote [shellName] Connects to the running system via a remote shell
105+
simulator [action] Start/stop simulator and generate random traffic
106+
start [options] [<chainName>] Start the forge and forge web deamon
107+
status [type] List info of the running chain/node
108+
stop [options] [<chainName>] Stop the forge daemon and all related services
109+
tx [hash] Get a tx detail and display
110+
tx:ls List latest transactions
111+
upgrade [<chainName>] Upgrade chain node to new version without reset
112+
use [version] Activate an already downloaded forge release
113+
version [<chainName>] Output version for all forge components
114+
wallet:create Create a local wallet and dump its public/private key
115+
web [action] Open the web interface of running forge chain/node
122116
123117
Examples:
124118

0 commit comments

Comments
 (0)