Skip to content

1722 consistent syntax #1880

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+41 −38
Open

1722 consistent syntax #1880

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb65a91
standardizes t/f syntax
m4sterbunny Nov 28, 2025
6942dcb
adds missing defaults
m4sterbunny Nov 28, 2025
2cf642e
Merge branch 'main' into 1722-consistent-syntax
m4sterbunny Nov 28, 2025
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
79 changes: 41 additions & 38 deletions docs/public-networks/reference/cli/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ For [`eth_gasPrice`](../api/index.md#eth_gasprice), to return the:
<TabItem value="Syntax" label="Syntax" default>

```bash
--auto-log-bloom-caching-enabled[=<true|false>]
--auto-log-bloom-caching-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -374,7 +374,7 @@ If you plan on querying historical blocks or state using the [JSON-RPC API](../a
<TabItem value="Syntax" label="Syntax" default>

```bash
--bonsai-limit-trie-logs-enabled=[=<true|false>]
--bonsai-limit-trie-logs-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -556,7 +556,7 @@ The default is `0`.
<TabItem value="Syntax" label="Syntax" default>

```bash
--color-enabled[=<true|false>]
--color-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -740,7 +740,7 @@ The `enrtree` URL of the DNS node list for [node discovery via DNS](https://eips
<TabItem value="Syntax" label="Syntax" default>

```bash
--discovery-enabled[=<true|false>]
--discovery-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -832,7 +832,7 @@ To allow all hostnames, use `"*"`. We don't recommend allowing all hostnames in
<TabItem value="Syntax" label="Syntax" default>

```bash
--engine-jwt-disabled[=<true|false>]
--engine-jwt-disabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -912,7 +912,7 @@ Shared secret used to authenticate [consensus clients](../../concepts/node-clien
<TabItem value="Syntax" label="Syntax" default>

```bash
--engine-rpc-enabled[=<true|false]>
--engine-rpc-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -1335,7 +1335,7 @@ You can't use the [`--genesis-file`](#genesis-file) and [`--network`](#network)
<TabItem value="Syntax" label="Syntax" default>

```bash
--genesis-state-hash-cache-enabled=[=<true|false>]
--genesis-state-hash-cache-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -1421,7 +1421,7 @@ A list of comma-separated origin domain URLs for CORS validation. The default is
<TabItem value="Syntax" label="Syntax" default>

```bash
--graphql-http-enabled[=<true|false>]
--graphql-http-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -1548,7 +1548,7 @@ The port (TCP) on which GraphQL HTTP listens. The default is `8547`. Ports must
<TabItem value="Syntax">

```bash
--graphql-mtls-enabled[=<true|false>]
--graphql-mtls-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -1588,7 +1588,7 @@ The default is `false`.
<TabItem value="Syntax">

```bash
--graphql-tls-enabled[=<true|false>]
--graphql-tls-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -1792,7 +1792,7 @@ Show the help message and exit.
<TabItem value="Syntax" label="Syntax" default>

```bash
--history-expiry-prune[=<true|false>]
--history-expiry-prune=<true|false>
```
</TabItem>

Expand Down Expand Up @@ -1935,7 +1935,7 @@ If a name is not specified, the name section is not included in the client ID. F
<TabItem value="Syntax" label="Syntax" default>

```bash
--json-pretty-print-enabled[=<true|false>]
--json-pretty-print-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -2179,7 +2179,7 @@ Other categories are `KVSTORE_ROCKSDB`, `KVSTORE_PRIVATE_ROCKSDB`, `KVSTORE_ROCK
<TabItem value="Syntax" label="Syntax" default>

```bash
--metrics-enabled[=<true|false>]
--metrics-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -2374,9 +2374,12 @@ metrics-push-enabled=true

</Tabs>

Enables or disables [push gateway integration].
Enables or disables [push gateway integration]. The default is `false`.

:::note

You can't specify `--metrics-push-enabled` with [`--metrics-enabled`](#metrics-enabled). That is, you can enable either Prometheus polling or Prometheus push gateway support, but not both at once.
:::

### `metrics-push-host`

Expand Down Expand Up @@ -2751,7 +2754,7 @@ fee recipient, if the consensus layer client doesn't provide any.
<TabItem value="Syntax" label="Syntax" default>

```bash
--miner-enabled[=<true|false>]
--miner-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -2961,7 +2964,7 @@ The predefined network configuration. The default is `mainnet`.

Possible values include the following:

| Network | Chain | Type | Default sync mode | Consensus mechanism | Description |
| Network | Chain | Type | Default sync mode | Consensus mechanism | description |
Copy link
Contributor

@alexandratran alexandratran Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Network | Chain | Type | Default sync mode | Consensus mechanism | description |
| Network | Chain | Type | Default sync mode | Consensus mechanism | Description |

Capitalize for consistency

|:-----------|:------|:------------|:---------------------|:--------------------|:-------------------------------------------------------------------------------|
| `mainnet` | ETH | Production | [`SNAP`](#sync-mode) | PoS network | The main [Ethereum network](https://ethereum.org/en/developers/docs/networks/) |
| `hoodi` | ETH | Test | [`SNAP`](#sync-mode) | PoS network | Multi-client Ethereum testnet [Hoodi](https://hoodi.ethpandaops.io/) |
Expand Down Expand Up @@ -3084,7 +3087,7 @@ This option is ignored if [`--security-module`](#security-module) is set to a no
<TabItem value="Syntax" label="Syntax" default>

```bash
--p2p-enabled[=<true|false>]
--p2p-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -3294,7 +3297,7 @@ The default is `50`: limiting plugins to up to 50% of the total block creation t
<TabItem value="Syntax">

```bash
--plugin-continue-on-error[=<true|false>]
--plugin-continue-on-error=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -3438,7 +3441,7 @@ The default is `null`.
<TabItem value="Syntax" label="Syntax" default>

```bash
--random-peer-priority-enabled[=<true|false>]
--random-peer-priority-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -3520,7 +3523,7 @@ The default is `false`.
<TabItem value="Syntax" label="Syntax" default>

```bash
--remote-connections-limit-enabled[=<true|false>]
--remote-connections-limit-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -3692,7 +3695,7 @@ Requires a peer with the specified block number to have the specified hash when
<TabItem value="Syntax" label="Syntax" default>

```bash
--revert-reason-enabled[=<true|false>]
--revert-reason-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -3944,7 +3947,7 @@ rpc-http-authentication-enabled=true

</Tabs>

Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC HTTP service.
Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC HTTP service. The default is `false`.

### `rpc-http-authentication-jwt-algorithm`

Expand Down Expand Up @@ -4094,7 +4097,7 @@ For testing and development purposes, use `"all"` or `"*"` to accept requests fr
<TabItem value="Syntax" label="Syntax" default>

```bash
--rpc-http-enabled[=<true|false>]
--rpc-http-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -4346,7 +4349,7 @@ The port (TCP) on which JSON-RPC HTTP listens. The default is `8545`. You must [
<TabItem value="Syntax" label="Syntax" default>

```bash
--rpc-http-tls-ca-clients-enabled[=<true|false>]
--rpc-http-tls-ca-clients-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -4392,7 +4395,7 @@ You must enable client authentication using the [`--rpc-http-tls-client-auth-ena
<TabItem value="Syntax" label="Syntax" default>

```bash
--rpc-http-tls-client-auth-enabled[=<true|false>]
--rpc-http-tls-client-auth-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -4484,7 +4487,7 @@ The singular `--rpc-http-tls-cipher-suite` and plural `--rpc-http-tls-cipher-sui
<TabItem value="Syntax" label="Syntax" default>

```bash
--rpc-http-tls-enabled[=<true|false>]
--rpc-http-tls-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -5085,7 +5088,7 @@ rpc-ws-authentication-enabled=true

</Tabs>

Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC WebSocket service.
Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC WebSocket service. The default is `false`.

:::note

Expand Down Expand Up @@ -5183,7 +5186,7 @@ The [JWT provider's public key file] used for JSON-RPC WebSocket authentication
<TabItem value="Syntax" label="Syntax" default>

```bash
--rpc-ws-enabled[=<true|false>]
--rpc-ws-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -5434,7 +5437,7 @@ Required if [`--rpc-ws-ssl-keystore-type`](#rpc-ws-ssl-keystore-type) is `PEM`.
<TabItem value="Syntax" label="Syntax" default>

```bash
--rpc-ws-ssl-client-auth-enabled[=<true|false>]
--rpc-ws-ssl-client-auth-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -5484,7 +5487,7 @@ If using JKS or PKCS12, specify the truststore password using [`--rpc-ws-ssl-tru
<TabItem value="Syntax" label="Syntax" default>

```bash
--rpc-ws-ssl-enabled[=<true|false>]
--rpc-ws-ssl-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -5997,7 +6000,7 @@ The default is the node's local private key file specified using [`--node-privat
<TabItem value="Syntax" label="Syntax" default>

```bash
--snapsync-server-enabled[=<true|false>]
--snapsync-server-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -6035,7 +6038,7 @@ The default is `false`.
<TabItem value="Syntax" label="Syntax" default>

```bash
--snapsync-synchronizer-pre-checkpoint-headers-only-enabled[=<true|false>]
--snapsync-synchronizer-pre-checkpoint-headers-only-enabled=<true|false>
```
</TabItem>

Expand Down Expand Up @@ -6076,7 +6079,7 @@ Setting this option to `false` increases sync time and disk space usage.
<TabItem value="Syntax" label="Syntax" default>

```bash
--snapsync-synchronizer-transaction-indexing-enabled[=<true|false>]
--snapsync-synchronizer-transaction-indexing-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -6162,7 +6165,7 @@ Static nodes JSON file containing the [static nodes](../../how-to/connect/static
<TabItem value="Syntax" label="Syntax" default>

```bash
--strict-tx-replay-protection-enabled[=<true|false>]
--strict-tx-replay-protection-enabled=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -6432,7 +6435,7 @@ The default is `100`.
<TabItem value="Syntax" label="Syntax" default>

```bash
--tx-pool-enable-balance-check[=<true|false>]
--tx-pool-enable-balance-check=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -6474,7 +6477,7 @@ The default is `false`.
<TabItem value="Syntax" label="Syntax" default>

```bash
--tx-pool-enable-save-restore[=<true|false>]
--tx-pool-enable-save-restore=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -6889,7 +6892,7 @@ all other pending transactions.
<TabItem value="Syntax" label="Syntax" default>

```bash
--tx-pool-no-local-priority[=<true|false>]
--tx-pool-no-local-priority=<true|false>
```

</TabItem>
Expand Down Expand Up @@ -7123,7 +7126,7 @@ Prints version information and exits.
<TabItem value="Syntax">

```bash
--version-compatibility-protection[=<true|false>]
--version-compatibility-protection=<true|false>
```

</TabItem>
Expand Down
Loading