Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix more formatting #2497

Merged
merged 1 commit into from
Nov 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/cdk/getting-started/cli-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,14 @@ Here, you need to provide the CDK node configuration file and the genesis file f
Usage: `cdk <COMMAND>`

Commands:

- `node` - Run the cdk-node with the provided configuration
- `erigon` - Run cdk-erigon node with the provided default configuration
- `versions` - Output the corresponding versions of the components
- `help` Print this message or the help of the given subcommand(s)

Options:

- `-h, --help` - Print help

### `cdk node`
Expand All @@ -38,6 +40,7 @@ To run cdk-node use the `node` subcommand with one of the options mentioned belo
Usage: `cdk node [OPTIONS]`

Options:

- `-C, --config <CONFIG>` - The path to the configuration file [env: `CDK_CONFIG_PATH=`]
- `-c, --components <COMPONENTS>` - Components to run [env: `CDK_COMPONENTS=`]
- `-h, --help` - Print help
Expand All @@ -64,6 +67,7 @@ This subcommand is intended for quickly spinning up an RPC node or testing exist
Usage: `cdk erigon [OPTIONS]`

Options:

- `-C, --config <CONFIG>` - The path to the cdk-node configuration file [env: `CDK_CONFIG_PATH=`]
- `-g, --chain <CHAIN>` - The path to the genesis.json file [env: `CDK_GENESIS_PATH=`]
- `-h, --help` - Print help
Expand All @@ -85,6 +89,7 @@ To print the corresponding versions of the components, run the following command
Usage: `cdk versions`

Options:

- `-h, --help` - Print help

Example:
Expand Down