Merge pull request #6888 from filecoin-project/feat/cli-super-verbose

add a very verbose -vv flag to lotus and lotus-miner.

cli/util/api.go

@@ -146,6 +146,10 @@ func GetRawAPI(ctx *cli.Context, t repo.RepoType, version string) (string, http.
 		return "", nil, xerrors.Errorf("could not get DialArgs: %w", err)
 	}
 
+	if IsVeryVerbose {
+		_, _ = fmt.Fprintf(ctx.App.Writer, "using raw API %s endpoint: %s\n", version, addr)
+	}
+
 	return addr, ainfo.AuthHeader(), nil
 }
 
@@ -185,6 +189,10 @@ func GetFullNodeAPI(ctx *cli.Context) (v0api.FullNode, jsonrpc.ClientCloser, err
 		return nil, nil, err
 	}
 
+	if IsVeryVerbose {
+		_, _ = fmt.Fprintln(ctx.App.Writer, "using full node API v0 endpoint:", addr)
+	}
+
 	return client.NewFullNodeRPCV0(ctx.Context, addr, headers)
 }
 
@@ -198,6 +206,10 @@ func GetFullNodeAPIV1(ctx *cli.Context) (v1api.FullNode, jsonrpc.ClientCloser, e
 		return nil, nil, err
 	}
 
+	if IsVeryVerbose {
+		_, _ = fmt.Fprintln(ctx.App.Writer, "using full node API v1 endpoint:", addr)
+	}
+
 	return client.NewFullNodeRPCV1(ctx.Context, addr, headers)
 }
 
@@ -242,6 +254,10 @@ func GetStorageMinerAPI(ctx *cli.Context, opts ...GetStorageMinerOption) (api.St
 		addr = u.String()
 	}
 
+	if IsVeryVerbose {
+		_, _ = fmt.Fprintln(ctx.App.Writer, "using miner API v0 endpoint:", addr)
+	}
+
 	return client.NewStorageMinerRPCV0(ctx.Context, addr, headers)
 }
 
@@ -251,6 +267,10 @@ func GetWorkerAPI(ctx *cli.Context) (api.Worker, jsonrpc.ClientCloser, error) {
 		return nil, nil, err
 	}
 
+	if IsVeryVerbose {
+		_, _ = fmt.Fprintln(ctx.App.Writer, "using worker API v0 endpoint:", addr)
+	}
+
 	return client.NewWorkerRPCV0(ctx.Context, addr, headers)
 }
 
@@ -260,6 +280,10 @@ func GetGatewayAPI(ctx *cli.Context) (api.Gateway, jsonrpc.ClientCloser, error)
 		return nil, nil, err
 	}
 
+	if IsVeryVerbose {
+		_, _ = fmt.Fprintln(ctx.App.Writer, "using gateway API v1 endpoint:", addr)
+	}
+
 	return client.NewGatewayRPCV1(ctx.Context, addr, headers)
 }
 
@@ -269,6 +293,10 @@ func GetGatewayAPIV0(ctx *cli.Context) (v0api.Gateway, jsonrpc.ClientCloser, err
 		return nil, nil, err
 	}
 
+	if IsVeryVerbose {
+		_, _ = fmt.Fprintln(ctx.App.Writer, "using gateway API v0 endpoint:", addr)
+	}
+
 	return client.NewGatewayRPCV0(ctx.Context, addr, headers)
 }
 

cli/util/verbose.go

@@ -0,0 +1,16 @@
+package cliutil
+
+import "github.com/urfave/cli/v2"
+
+// IsVeryVerbose is a global var signalling if the CLI is running in very
+// verbose mode or not (default: false).
+var IsVeryVerbose bool
+
+// FlagVeryVerbose enables very verbose mode, which is useful when debugging
+// the CLI itself. It should be included as a flag on the top-level command
+// (e.g. lotus -vv, lotus-miner -vv).
+var FlagVeryVerbose = &cli.BoolFlag{
+	Name:        "vv",
+	Usage:       "enables very verbose mode, useful for debugging the CLI",
+	Destination: &IsVeryVerbose,
+}

cmd/lotus-miner/main.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 
 	"github.com/fatih/color"
+	cliutil "github.com/filecoin-project/lotus/cli/util"
 	logging "github.com/ipfs/go-log/v2"
 	"github.com/urfave/cli/v2"
 	"go.opencensus.io/trace"
@@ -105,6 +106,7 @@ func main() {
 				Value:   "~/.lotusminer", // TODO: Consider XDG_DATA_HOME
 				Usage:   fmt.Sprintf("Specify miner repo path. flag(%s) and env(LOTUS_STORAGE_PATH) are DEPRECATION, will REMOVE SOON", FlagMinerRepoDeprecation),
 			},
+			cliutil.FlagVeryVerbose,
 		},
 
 		Commands: append(local, lcli.CommonCommands...),

cmd/lotus/main.go

@@ -12,6 +12,7 @@ import (
 	"github.com/filecoin-project/lotus/api"
 	"github.com/filecoin-project/lotus/build"
 	lcli "github.com/filecoin-project/lotus/cli"
+	cliutil "github.com/filecoin-project/lotus/cli/util"
 	"github.com/filecoin-project/lotus/lib/lotuslog"
 	"github.com/filecoin-project/lotus/lib/tracing"
 	"github.com/filecoin-project/lotus/node/repo"
@@ -81,6 +82,7 @@ func main() {
 				Name:  "force-send",
 				Usage: "if true, will ignore pre-send checks",
 			},
+			cliutil.FlagVeryVerbose,
 		},
 
 		Commands: append(local, lcli.Commands...),

documentation/en/cli-lotus-miner.md

@@ -43,6 +43,7 @@ GLOBAL OPTIONS:
    --actor value, -a value                  specify other actor to check state for (read only)
    --color                                  use color in display output (default: depends on output being a TTY)
    --miner-repo value, --storagerepo value  Specify miner repo path. flag(storagerepo) and env(LOTUS_STORAGE_PATH) are DEPRECATION, will REMOVE SOON (default: "~/.lotusminer") [$LOTUS_MINER_PATH, $LOTUS_STORAGE_PATH]
+   --vv                                     enables very verbose mode, useful for debugging the CLI (default: false)
    --help, -h                               show help (default: false)
    --version, -v                            print the version (default: false)
 ```

documentation/en/cli-lotus.md

@@ -39,6 +39,7 @@ COMMANDS:
 GLOBAL OPTIONS:
    --interactive  setting to false will disable interactive functionality of commands (default: false)
    --force-send   if true, will ignore pre-send checks (default: false)
+   --vv           enables very verbose mode, useful for debugging the CLI (default: false)
    --help, -h     show help (default: false)
    --version, -v  print the version (default: false)
 ```