You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cdk/getting-started/cdk-cli-tool.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
The Polygon Chain Development Kit, or simply CDK, is a tool box of components that a chain administrator can use to build a rollup or validium chain.
1
+
The Polygon Chain Development Kit (CDK) is a comprehensive set of components that enable chain administrators to build and deploy rollup or validium chains.
2
2
3
-
At a high level, CDK components are like building blocks a chain administrator can select to configure a ZK-powered chain according to their own design.
3
+
At a high level, CDK components are like modular building blocks that a chain administrator can use to configure a ZK-powered chain tailored to their design requirements.
4
4
5
-
To abstract away the complexity of running or configuring CDK components, Polygon provides a Rust-based CLI tool which is an interface that chain administrators can use to interact with CDK components.
5
+
To simplify the process of running and configuring CDK components, Polygon provides a Rust-based CLI tool which is an interface that chain administrators can use to interact with the components.
6
6
7
7
This CLI tool is an entry point for chain administrators to access the CDK system.
8
8
9
9
## Installation
10
10
11
-
To use the CLI tool the chain admin needs only download the precompiled CDK package ([the binaries](https://github.com/0xPolygon/cdk/releases/)).
11
+
As the chain admin, you simply need to download the precompiled [CDK package binaries](https://github.com/0xPolygon/cdk/releases/).
12
12
13
-
There is no need to have Golang, checkout the CDK repo, or install anything else. It is also trustless.
13
+
There is no need to install Golang, browse the CDK repo, or set up any additional tools. Moreover, the process is entirely trustless.
14
14
15
15
## Running the CLI tool
16
16
@@ -24,7 +24,7 @@ There is no need to have Golang, checkout the CDK repo, or install anything else
24
24
25
25
### CDK
26
26
27
-
Here the Admin needs to provide the CDK-node configuration file and a genesis file of the desired chain.
27
+
Here, you need to provide the CDKnode configuration file and the genesis file for your desired chain.
28
28
29
29
Usage: `cdk <COMMAND>`
30
30
@@ -37,9 +37,9 @@ Commands:
37
37
Options:
38
38
*`-h, --help` - Print help
39
39
40
-
### cdk node
40
+
### `cdk node`
41
41
42
-
To run cdk-node use the `node` subcommand
42
+
To run cdk-node use the `node` subcommand with one of the options mentioned below.
43
43
44
44
Usage: `cdk node [OPTIONS]`
45
45
@@ -48,11 +48,11 @@ Options:
48
48
*`-c, --components <COMPONENTS>` - Components to run [env: `CDK_COMPONENTS=`]
49
49
*`-h, --help` - Print help
50
50
51
-
### cdk erigon
51
+
### `cdk erigon`
52
52
53
-
Chain administrators can run a cdk-erigon RPC node that syncs to an existing chain with default parameters.
53
+
You can run a cdk-erigon RPC node that syncs to an existing chain using the default parameters.
54
54
55
-
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.
55
+
This subcommand is intended for quickly spinning up an RPC node or testing existing chains with default configuration values. In order to fine-tune settings and access all available configuration options, refer to the [full cdk-erigon documentation](../../cdk/getting-started/cdk-erigon/index.md)on Erigon configuration.
56
56
57
57
Usage: `cdk erigon [OPTIONS]`
58
58
@@ -61,11 +61,11 @@ Options:
61
61
*`-g, --chain <CHAIN>` - The path to a chain specification file [env: `CDK_GENESIS_PATH=`]
62
62
*`-h, --help` - Print help
63
63
64
-
### cdk versions
64
+
### `cdk versions`
65
65
66
-
The above command generates all the required configuration files for cdk-erigon on-the-fly and run the node.
66
+
The above command generates all the required configuration files for cdk-erigon onthefly and runs the node.
67
67
68
-
Output the corresponding versions of the components
68
+
To print the corresponding versions of the components, run the following command:
0 commit comments