Skip to content

Commit

Permalink
doc: add exmples
Browse files Browse the repository at this point in the history
  • Loading branch information
vcastellm authored Oct 17, 2024
1 parent 5608f73 commit 79ba486
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/cdk/getting-started/cdk-cli-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ This CLI tool is an entry point for chain administrators to access the CDK syste

As the chain admin, you simply need to download the precompiled [CDK package binaries](https://github.com/0xPolygon/cdk/releases/).

There is no need to install Golang, browse the CDK repo, or set up any additional tools. Moreover, the process is entirely trustless.

## Running the CLI tool

!!! info
Expand Down Expand Up @@ -48,6 +46,12 @@ Options:
* `-c, --components <COMPONENTS>` - Components to run [env: `CDK_COMPONENTS=`]
* `-h, --help` - Print help

Example:

```
cdk node --config /etc/cdk/cdk-node-config.toml --components sequence-sender,aggregator
```

### `cdk erigon`

You can run a cdk-erigon RPC node that syncs to an existing chain using the default parameters.
Expand All @@ -71,3 +75,9 @@ Usage: `cdk versions`

Options:
* `-h, --help` - Print help

Example:

```
cdk erigon --config /etc/cdk/cdk-node-config.toml --chain genesis.json
```

0 comments on commit 79ba486

Please sign in to comment.