go-ethereum/docs/README.md
Jerry a37af35c36 Add default values to CLI helper and docs
This commit adds default values to CLI helper and docs. When the default value of a string flag, slice string flag, or map string flag is empty, its helper message won't show any default value.
2022-12-13 23:23:10 -08:00

26 lines
1,022 B
Markdown

# Documentation
- [The new command line interface](./cli)
## Additional notes
- The new entrypoint to run the Bor client is ```server```.
```
$ bor server <flags>
```
See [here](./cli/server.md) for more flag details.
- The `bor dumpconfig` sub-command prints the default configurations, in the TOML format, on the terminal. One can `pipe (>)` this to a file (say `config.toml`) and use it to start bor.
- A toml file now can be used instead of flags and can contain all configuration for the node to run. To simply run bor with a configuration file, the following command can be used.
```
$ bor server --config <path_to_config.toml>
```
- You can find an example config file [here](./cli/example_config.toml) to know more about what each flag is used for, what are the defaults and recommended values for different networks.
- Toml files used earlier (with `--config` flag) to configure additional fields (like static and trusted nodes) are being deprecated and have been converted to flags.