Skip to content

Commit 525fe65

Browse files
committed
docs(cli): include generate help
1 parent fb81fb0 commit 525fe65

2 files changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,4 +144,28 @@ Commands:
144144
generate [options] Generate node identities, configure consensus, and emit a
145145
Besu genesis.
146146
help [command] display help for command
147+
148+
149+
Usage: network-bootstrapper generate [options]
150+
151+
Generate node identities, configure consensus, and emit a Besu genesis.
152+
153+
Options:
154+
-v, --validators <count> Number of validator nodes to generate. (default: 4)
155+
-a, --allocations <file> Path to a genesis allocations JSON file. (default: none)
156+
-o, --outputType <type> Output target (screen, file, kubernetes). (default: "screen")
157+
--static-node-domain <domain> DNS suffix appended to validator peer hostnames for static-nodes entries.
158+
--static-node-namespace <name> Namespace segment inserted between service name and domain for static-nodes entries.
159+
--static-node-port <number> P2P port used for static-nodes enode URIs. (default: 30303)
160+
--static-node-discovery-port <number> Discovery port used for static-nodes enode URIs. (default: 30303)
161+
--consensus <algorithm> Consensus algorithm (IBFTv2, QBFT). (default: QBFT)
162+
--chain-id <number> Chain ID for the genesis config. (default: random between 40000 and 50000)
163+
--seconds-per-block <number> Block time in seconds. (default: 2)
164+
--gas-limit <decimal> Block gas limit in decimal form. (default: 9007199254740991)
165+
--gas-price <number> Base gas price (wei). (default: 0)
166+
--evm-stack-size <number> EVM stack size limit. (default: 2048)
167+
--contract-size-limit <number> Contract size limit in bytes. (default: 2147483647)
168+
--accept-defaults Accept default values for all prompts when CLI flags are omitted. (default: disabled)
169+
-h, --help display help for command
170+
147171
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"test": "bun test",
2727
"helm": "helm upgrade --install network ./charts/network -n network --create-namespace --timeout 15m",
2828
"docs:helm": "helm-docs --chart-search-root=. --skip-version-footer",
29-
"docs:cli": "cat README.tpl > README.md && echo '\n```' >> README.md && bun src/index.ts --help >> README.md && echo '```' >> README.md",
29+
"docs:cli": "cat README.tpl > README.md && printf '\\n```\\n' >> README.md && bun src/index.ts --help >> README.md && printf '\\n\\n' >> README.md && bun src/index.ts generate --help >> README.md && printf '\\n```\\n' >> README.md",
3030
"package:pack": "helm package charts/network --destination .",
3131
"package:push:harbor": "helm push ./network-*.tgz oci://harbor.settlemint.com/atk"
3232
},

0 commit comments

Comments
 (0)