Skip to content

Commit ab4c60f

Browse files
authored
doc: update cli docs
1 parent e19ddaa commit ab4c60f

File tree

1 file changed

+25
-14
lines changed

1 file changed

+25
-14
lines changed

docs/cdk/getting-started/cdk-cli-tool.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,37 +26,48 @@ There is no need to have Golang, checkout the CDK repo, or install anything else
2626

2727
Here the Admin needs to provide the CDK-node configuration file and a genesis file of the desired chain.
2828

29-
Usage: `cdk --config <CONFIG> --chain <CHAIN> <COMMAND>`
29+
Usage: `cdk <COMMAND>`
3030

3131
Commands:
32-
* `node` - Run the cdk-node with the provided configuration.
33-
* `erigon` - Run cdk-erigon node with the provided default configuration.
34-
* `help` Print this message or the help of the given subcommand(s).
32+
* `node` - Run the cdk-node with the provided configuration
33+
* `erigon` - Run cdk-erigon node with the provided default configuration
34+
* `versions` - Output the corresponding versions of the components
35+
* `help` Print this message or the help of the given subcommand(s)
3536

3637
Options:
37-
* `-c, --config <CONFIG>` - The path to the configuration file [env: `CDK_CONFIG_PATH=`]
38-
* `-g, --chain <CHAIN>` - The path to a chain specification file [env: `CDK_GENESIS_PATH=`]
39-
* `-h, --help` Print help
38+
* `-h, --help` - Print help
4039

41-
### CDK node
40+
### cdk node
4241

4342
To run cdk-node use the `node` subcommand
4443

45-
Usage: `cdk --config <CONFIG> --chain <CHAIN> node [OPTIONS]`
44+
Usage: `cdk node [OPTIONS]`
4645

4746
Options:
48-
* `-c, --components <COMPONENTS>` Components to run [env: `CDK_COMPONENTS=`]
49-
* `-h, --help` Print help
47+
* `-C, --config <CONFIG>` - The path to the configuration file [env: `CDK_CONFIG_PATH=`]
48+
* `-c, --components <COMPONENTS>` - Components to run [env: `CDK_COMPONENTS=`]
49+
* `-h, --help` - Print help
5050

51-
### CDK erigon
51+
### cdk erigon
5252

5353
Chain administrators can run a cdk-erigon RPC node that syncs to an existing chain with default parameters.
5454

5555
This subcommand is intended for quickly spin-up of an RPC node or to test existing chains with default configuration values. In order fine tune and to access all configuration values, check the [full cdk-erigon documentation](../../cdk/getting-started/cdk-erigon/index.md) reference to erigon configuration docs.
5656

57-
Usage: `cdk --config <CONFIG> --chain <CHAIN> erigon`
57+
Usage: `cdk erigon [OPTIONS]`
5858

5959
Options:
60-
* `-h, --help` Print help
60+
* `-C, --config <CONFIG>` - The path to the configuration file [env: `CDK_CONFIG_PATH=`]
61+
* `-g, --chain <CHAIN>` - The path to a chain specification file [env: `CDK_GENESIS_PATH=`]
62+
* `-h, --help` - Print help
63+
64+
### cdk versions
6165

6266
The above command generates all the required configuration files for cdk-erigon on-the-fly and run the node.
67+
68+
Output the corresponding versions of the components
69+
70+
Usage: `cdk versions`
71+
72+
Options:
73+
* `-h, --help` - Print help

0 commit comments

Comments
 (0)