diff --git a/docs/cdk/cdk-cli-tool.md b/docs/cdk/cdk-cli-tool.md deleted file mode 100644 index c46cd13d..00000000 --- a/docs/cdk/cdk-cli-tool.md +++ /dev/null @@ -1,62 +0,0 @@ -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. - -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. - -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. - -This CLI tool is an entry point for chain administrators to access the CDK system. - -## Installation - -To use the CLI tool the chain admin needs only download the precompiled CDK package ([the binaries](https://github.com/0xPolygon/cdk/releases/)). - -There is no need to have Golang, checkout the CDK repo, or install anything else. It is also trustless. - -## Running the CLI tool - -!!! info - - Requirements: - - Get the binaries, packages and docker images published with each release, [here](https://github.com/0xPolygon/cdk/releases/). - -## Commands - -### CDK - -Here the Admin needs to provide the [cdk-node configuration file](needs a reference to the configuration doc) and a genesis file of the desired chain. - -Usage: `cdk --config --chain ` - -Commands: -* `node` - Run the cdk-node with the provided configuration. -* `erigon` - Run cdk-erigon node with the provided default configuration. -* `help` Print this message or the help of the given subcommand(s). - -Options: -* `-c, --config ` - The path to the configuration file [env: `CDK_CONFIG_PATH=`] -* `-g, --chain ` - The path to a chain specification file [env: `CDK_GENESIS_PATH=`] -* `-h, --help` Print help - -### CDK node - -To run cdk-node use the `node` subcommand - -Usage: `cdk --config --chain node [OPTIONS]` - -Options: -* `-c, --components ` Components to run [env: `CDK_COMPONENTS=`] -* `-h, --help` Print help - -### CDK erigon - -Chain administrators can run a cdk-erigon RPC node that syncs to an existing chain with default parameters. - -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](reference to erigon configuration docs). - -Usage: `cdk --config --chain erigon` - -Options: -* `-h, --help` Print help - -The above command generates all the required configuration files for cdk-erigon on-the-fly and run the node. diff --git a/mkdocs.yml b/mkdocs.yml index 34ddbfe0..9e55063f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -56,7 +56,6 @@ nav: - Releases: - Version compatibility matrix: cdk/releases/version-matrix.md - Stack components: cdk/releases/stack-components.md - - CLI tool: cdk/cdk-cli-tool.md - Get started: - Local deployment guide: cdk/getting-started/local-deployment.md - CLI tool: cdk/getting-started/cdk-cli-tool.md