Help updates (#464)

* update help text

* update

* update

Author: syntrust

cmd/es-node/main.go

@@ -74,8 +74,8 @@ func main() {
 		{
 			Name:      "init",
 			Aliases:   []string{"i"},
-			Usage:     `Init storage node by creating a data file for each shard. Type 'es-node init --help' for more information.`,
-			UsageText: `You can specify shard_len (the number of shards) or shard_index (the index of specified shard, and you can specify more than one) to mine. If both appears, shard_index takes precedence. `,
+			Usage:     `Initialize shard data files (one per shard). Type 'es-node init --help' for more information.`,
+			UsageText: `Use --shard_len to create N sequential shards starting at 0, or --shard_index to list one or more explicit shard indices (repeatable). If both are supplied, --shard_index wins.`,
 			Flags: []cli.Flag{
 				cli.Uint64Flag{
 					Name:  shardLenFlagName,
@@ -100,8 +100,8 @@ func main() {
 		{
 			Name:      "sync",
 			Aliases:   []string{"s"},
-			Usage:     fmt.Sprintf("Download a blob from an RPC node and update it in local storage. Type 'es-node sync --help' for more information."),
-			UsageText: fmt.Sprintf("Sync local data specified by `%s` from RPC specified by `%s`", kvIndexFlagName, esRpcFlagName),
+			Usage:     "Fetch a single blob (by KV index) from a remote EthStorage RPC and write it into local storage. Type 'es-node sync --help' for more information.",
+			UsageText: fmt.Sprintf("Requires --%s (KV index) and --%s (RPC endpoint).", kvIndexFlagName, esRpcFlagName),
 			Flags: []cli.Flag{
 				cli.Uint64Flag{
 					Name:  kvIndexFlagName,
@@ -121,8 +121,8 @@ func main() {
 		},
 		{
 			Name:    "email",
-			Aliases: []string{"mail"},
-			Usage:   "Send a test email using the configured SMTP settings",
+			Aliases: []string{"m"},
+			Usage:   "Send a test email using the configured SMTP settings.",
 			Flags:   email.CLIFlags(),
 			Action: func(ctx *cli.Context) error {
 				emailConfig, err := email.GetEmailConfig(ctx)

ethstorage/flags/flags.go

@@ -25,17 +25,17 @@ var (
 	//}
 	DataDir = cli.StringFlag{
 		Name:   "datadir",
-		Usage:  "Data directory for the storage files, databases and keystore",
+		Usage:  "(Required) Data directory for the storage files, databases and keystore",
 		EnvVar: utils.PrefixEnvVar("DATADIR"),
 	}
 	L1NodeAddr = cli.StringFlag{
 		Name:   "l1.rpc",
-		Usage:  "Address of L1 User JSON-RPC endpoint to use (eth namespace required)",
+		Usage:  "(Required) Address of L1 User JSON-RPC endpoint to use (eth namespace required)",
 		EnvVar: utils.PrefixEnvVar("L1_ETH_RPC"),
 	}
 	L1BeaconAddr = cli.StringFlag{
 		Name:   "l1.beacon",
-		Usage:  "Address of L1 beacon chain endpoint to use",
+		Usage:  "(Required) Address of L1 beacon chain endpoint to use",
 		EnvVar: utils.PrefixEnvVar("L1_BEACON_URL"),
 	}
 	L1BlockTime = cli.Uint64Flag{
@@ -128,7 +128,7 @@ var (
 	// TODO: move storage flag to storage folder
 	StorageFiles = cli.StringSliceFlag{
 		Name:   "storage.files",
-		Usage:  "File paths where the data are stored",
+		Usage:  "(Required) File paths where the data are stored",
 		EnvVar: utils.PrefixEnvVar("STORAGE_FILES"),
 	}
 	StorageMiner = cli.StringFlag{
@@ -138,7 +138,7 @@ var (
 	}
 	StorageL1Contract = cli.StringFlag{
 		Name:   "storage.l1contract",
-		Usage:  "Storage contract address on l1",
+		Usage:  "(Required) Storage contract address on l1",
 		EnvVar: utils.PrefixEnvVar("STORAGE_L1CONTRACT"),
 	}
 	StorageKvSize = cli.Uint64Flag{