chore: style cmd usage strings (#714)

* fix: sentence-style usage strings

* docs: make gen-doc

* chore: style cmd short usage strings

* fix: long usage strings

* docs: make gen-doc

Author: minhd-vu

CLAUDE.md

@@ -146,3 +146,9 @@ The tool supports configuration via:
   f.StringVar(&myVar, "name", "", "description")
   f.IntVar(&count, "count", 0, "description")
   ```
+
+### Cobra Commands
+- Command `Short` descriptions: sentence case with ending period, e.g., `"Generate a node list to seed a node."`
+- Command `Long` descriptions: consider using embedded usage.md file via `//go:embed usage.md` pattern; when using inline strings, use sentence case with ending period for complete sentences
+- Command `Short` should be brief (~50 characters or less), appears in help menus and command lists
+- Command `Long` provides detailed explanation, can be empty if `Short` is sufficient

README.md

@@ -41,23 +41,23 @@ Note: Do not modify this section! It is auto-generated by `cobra` using `make ge
 
 - [polycli abi](doc/polycli_abi.md) - Provides encoding and decoding functionalities with contract signatures and ABI.
 
-- [polycli cdk](doc/polycli_cdk.md) - Utilities for interacting with CDK networks
+- [polycli cdk](doc/polycli_cdk.md) - Utilities for interacting with CDK networks.
 
-- [polycli contract](doc/polycli_contract.md) - Interact with smart contracts and fetch contract information from the blockchain
+- [polycli contract](doc/polycli_contract.md) - Interact with smart contracts and fetch contract information from the blockchain.
 
-- [polycli dbbench](doc/polycli_dbbench.md) - Perform a level/pebble db benchmark
+- [polycli dbbench](doc/polycli_dbbench.md) - Perform a level/pebble db benchmark.
 
-- [polycli dockerlogger](doc/polycli_dockerlogger.md) - Monitor and filter Docker container logs
+- [polycli dockerlogger](doc/polycli_dockerlogger.md) - Monitor and filter Docker container logs.
 
 - [polycli dumpblocks](doc/polycli_dumpblocks.md) - Export a range of blocks from a JSON-RPC endpoint.
 
-- [polycli ecrecover](doc/polycli_ecrecover.md) - Recovers and returns the public key of the signature
+- [polycli ecrecover](doc/polycli_ecrecover.md) - Recovers and returns the public key of the signature.
 
-- [polycli enr](doc/polycli_enr.md) - Convert between ENR and Enode format
+- [polycli enr](doc/polycli_enr.md) - Convert between ENR and Enode format.
 
-- [polycli fix-nonce-gap](doc/polycli_fix-nonce-gap.md) - Send txs to fix the nonce gap for a specific account
+- [polycli fix-nonce-gap](doc/polycli_fix-nonce-gap.md) - Send txs to fix the nonce gap for a specific account.
 
-- [polycli fold-trace](doc/polycli_fold-trace.md) - Trace an execution trace and fold it for visualization
+- [polycli fold-trace](doc/polycli_fold-trace.md) - Trace an execution trace and fold it for visualization.
 
 - [polycli fork](doc/polycli_fork.md) - Take a forked block and walk up the chain to do analysis.
 
@@ -73,27 +73,27 @@ Note: Do not modify this section! It is auto-generated by `cobra` using `make ge
 
 - [polycli monitor](doc/polycli_monitor.md) - Monitor blocks using a JSON-RPC endpoint.
 
-- [polycli monitorv2](doc/polycli_monitorv2.md) - Monitor v2 command stub
+- [polycli monitorv2](doc/polycli_monitorv2.md) - Monitor v2 command stub.
 
 - [polycli nodekey](doc/polycli_nodekey.md) - Generate node keys for different blockchain clients and protocols.
 
 - [polycli p2p](doc/polycli_p2p.md) - Set of commands related to devp2p.
 
-- [polycli parse-batch-l2-data](doc/polycli_parse-batch-l2-data.md) - Convert batch l2 data into an ndjson stream
+- [polycli parse-batch-l2-data](doc/polycli_parse-batch-l2-data.md) - Convert batch l2 data into an ndjson stream.
 
 - [polycli parseethwallet](doc/polycli_parseethwallet.md) - Extract the private key from an eth wallet.
 
-- [polycli publish](doc/polycli_publish.md) - Publish transactions to the network with high-throughput
+- [polycli publish](doc/polycli_publish.md) - Publish transactions to the network with high-throughput.
 
-- [polycli retest](doc/polycli_retest.md) - Convert the standard ETH test fillers into something to be replayed against an RPC
+- [polycli retest](doc/polycli_retest.md) - Convert the standard ETH test fillers into something to be replayed against an RPC.
 
 - [polycli rpcfuzz](doc/polycli_rpcfuzz.md) - Continually run a variety of RPC calls and fuzzers.
 
-- [polycli signer](doc/polycli_signer.md) - Utilities for security signing transactions
+- [polycli signer](doc/polycli_signer.md) - Utilities for security signing transactions.
 
-- [polycli ulxly](doc/polycli_ulxly.md) - Utilities for interacting with the uLxLy bridge
+- [polycli ulxly](doc/polycli_ulxly.md) - Utilities for interacting with the uLxLy bridge.
 
-- [polycli version](doc/polycli_version.md) - Get the current version of this application
+- [polycli version](doc/polycli_version.md) - Get the current version of this application.
 
 - [polycli wallet](doc/polycli_wallet.md) - Create or inspect BIP39(ish) wallets.
 

cmd/abi/encode/encode.go

@@ -17,7 +17,7 @@ var (
 
 var ABIEncodeCmd = &cobra.Command{
 	Use:   "encode [function signature] [args...]",
-	Short: "ABI encodes a function signature and the inputs",
+	Short: "ABI encodes a function signature and the inputs.",
 	Long:  "[function-signature] is required and is a fragment in the form <function name>(<types...>). If the function signature has parameters, then those values would have to be passed as arguments after the function signature.",
 	Args:  cobra.MinimumNArgs(1),
 	PreRunE: func(cmd *cobra.Command, args []string) error {

cmd/cdk/bridge.go

@@ -13,15 +13,15 @@ import (
 
 var bridgeCmd = &cobra.Command{
 	Use:   "bridge",
-	Short: "Utilities for interacting with CDK bridge contract",
+	Short: "Utilities for interacting with CDK bridge contract.",
 	Args:  cobra.NoArgs,
 }
 
 //go:embed bridgeInspectUsage.md
 var bridgeInspectUsage string
 var bridgeInspectCmd = &cobra.Command{
 	Use:   "inspect",
-	Short: "List some basic information about the bridge",
+	Short: "List some basic information about the bridge.",
 	Long:  bridgeInspectUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -33,7 +33,7 @@ var bridgeInspectCmd = &cobra.Command{
 var bridgeDumpUsage string
 var bridgeDumpCmd = &cobra.Command{
 	Use:   "dump",
-	Short: "List detailed information about the bridge",
+	Short: "List detailed information about the bridge.",
 	Long:  bridgeDumpUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -45,7 +45,7 @@ var bridgeDumpCmd = &cobra.Command{
 var bridgeMonitorUsage string
 var bridgeMonitorCmd = &cobra.Command{
 	Use:   "monitor",
-	Short: "Watch for bridge events and display them on the fly",
+	Short: "Watch for bridge events and display them on the fly.",
 	Long:  bridgeMonitorUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {

cmd/cdk/cdk.go

@@ -104,8 +104,8 @@ var (
 
 var CDKCmd = &cobra.Command{
 	Use:   "cdk",
-	Short: "Utilities for interacting with CDK networks",
-	Long:  "Basic utility commands for interacting with the cdk contracts",
+	Short: "Utilities for interacting with CDK networks.",
+	Long:  "Basic utility commands for interacting with the cdk contracts.",
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
 		rpcURL := flag_loader.GetRpcUrlFlagValue(cmd)
 		if rpcURL != nil {

cmd/cdk/ger.go

@@ -13,15 +13,15 @@ import (
 
 var gerCmd = &cobra.Command{
 	Use:   "ger",
-	Short: "Utilities for interacting with CDK global exit root manager contract",
+	Short: "Utilities for interacting with CDK global exit root manager contract.",
 	Args:  cobra.NoArgs,
 }
 
 //go:embed gerInspectUsage.md
 var gerInspectUsage string
 var gerInspectCmd = &cobra.Command{
 	Use:   "inspect",
-	Short: "List some basic information about the global exit root manager",
+	Short: "List some basic information about the global exit root manager.",
 	Long:  gerInspectUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -33,7 +33,7 @@ var gerInspectCmd = &cobra.Command{
 var gerDumpUsage string
 var gerDumpCmd = &cobra.Command{
 	Use:   "dump",
-	Short: "List detailed information about the global exit root manager",
+	Short: "List detailed information about the global exit root manager.",
 	Long:  gerDumpUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -45,7 +45,7 @@ var gerDumpCmd = &cobra.Command{
 var gerMonitorUsage string
 var gerMonitorCmd = &cobra.Command{
 	Use:   "monitor",
-	Short: "Watch for global exit root manager events and display them on the fly",
+	Short: "Watch for global exit root manager events and display them on the fly.",
 	Long:  gerMonitorUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {

cmd/cdk/rollup.go

@@ -18,7 +18,7 @@ import (
 
 var rollupCmd = &cobra.Command{
 	Use:   "rollup",
-	Short: "Utilities for interacting with CDK rollup manager to get rollup specific information",
+	Short: "Utilities for interacting with CDK rollup manager to get rollup specific information.",
 	Args:  cobra.NoArgs,
 }
 
@@ -27,7 +27,7 @@ var rollupInspectUsage string
 
 var rollupInspectCmd = &cobra.Command{
 	Use:   "inspect",
-	Short: "List some basic information about a specific rollup",
+	Short: "List some basic information about a specific rollup.",
 	Long:  rollupInspectUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -40,7 +40,7 @@ var rollupDumpUsage string
 
 var rollupDumpCmd = &cobra.Command{
 	Use:   "dump",
-	Short: "List detailed information about a specific rollup",
+	Short: "List detailed information about a specific rollup.",
 	Long:  rollupDumpUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -53,7 +53,7 @@ var rollupMonitorUsage string
 
 var rollupMonitorCmd = &cobra.Command{
 	Use:   "monitor",
-	Short: "Watch for rollup events and display them on the fly",
+	Short: "Watch for rollup events and display them on the fly.",
 	Long:  rollupMonitorUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {

cmd/cdk/rollup_manager.go

@@ -14,7 +14,7 @@ import (
 
 var rollupManagerCmd = &cobra.Command{
 	Use:   "rollup-manager",
-	Short: "Utilities for interacting with CDK rollup manager contract",
+	Short: "Utilities for interacting with CDK rollup manager contract.",
 	Args:  cobra.NoArgs,
 }
 
@@ -23,7 +23,7 @@ var rollupManagerListRollupsUsage string
 
 var rollupManagerListRollupsCmd = &cobra.Command{
 	Use:   "list-rollups",
-	Short: "List some basic information about each rollup",
+	Short: "List some basic information about each rollup.",
 	Long:  rollupManagerListRollupsUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -36,7 +36,7 @@ var rollupManagerListRollupTypesUsage string
 
 var rollupManagerListRollupTypesCmd = &cobra.Command{
 	Use:   "list-rollup-types",
-	Short: "List some basic information about each rollup type",
+	Short: "List some basic information about each rollup type.",
 	Long:  rollupManagerListRollupTypesUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -49,7 +49,7 @@ var rollupManagerInspectUsage string
 
 var rollupManagerInspectCmd = &cobra.Command{
 	Use:   "inspect",
-	Short: "List some basic information about the rollup manager",
+	Short: "List some basic information about the rollup manager.",
 	Long:  rollupManagerInspectUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -62,7 +62,7 @@ var rollupManagerDumpUsage string
 
 var rollupManagerDumpCmd = &cobra.Command{
 	Use:   "dump",
-	Short: "List detailed information about the rollup manager",
+	Short: "List detailed information about the rollup manager.",
 	Long:  rollupManagerDumpUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -75,7 +75,7 @@ var rollupManagerMonitorUsage string
 
 var rollupManagerMonitorCmd = &cobra.Command{
 	Use:   "monitor",
-	Short: "Watch for rollup manager events and display them on the fly",
+	Short: "Watch for rollup manager events and display them on the fly.",
 	Long:  rollupManagerMonitorUsage,
 	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {

cmd/contract/cmd.go

@@ -43,7 +43,7 @@ type ContractInfo struct {
 
 var Cmd = &cobra.Command{
 	Use:   "contract",
-	Short: "Interact with smart contracts and fetch contract information from the blockchain",
+	Short: "Interact with smart contracts and fetch contract information from the blockchain.",
 	Long:  usage,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
 		rpcURL := flag_loader.GetRpcUrlFlagValue(cmd)

cmd/dbbench/dbbench.go

@@ -138,7 +138,7 @@ func NewTestResult(startTime, endTime time.Time, desc string, opCount uint64) *T
 
 var DBBenchCmd = &cobra.Command{
 	Use:   "dbbench [flags]",
-	Short: "Perform a level/pebble db benchmark",
+	Short: "Perform a level/pebble db benchmark.",
 	Long:  usage,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		log.Info().Msg("Starting db test")