feat: generate CLI docs without needing compiled binaries

Author: Aryan Tikarya

CHANGELOG.md

@@ -16,10 +16,10 @@
 - Add Magik's bootstrap node. ([filecoin-project/lotus#12792](https://github.com/filecoin-project/lotus/pull/12792))
 - Lotus now reports the network name as a tag in most metrics. Some untagged metrics will be completed in a follow-up at a later date. ([filecoin-project/lotus#12733](https://github.com/filecoin-project/lotus/pull/12733))
 - Refactored Ethereum API implementation into smaller, more manageable modules in a new `github.com/filecoin-project/lotus/node/impl/eth` package. ([filecoin-project/lotus#12796](https://github.com/filecoin-project/lotus/pull/12796))
+- Generate the cli docs directly from the code instead compiling and executing binaries' `help` output. ([filecoin-project/lotus#12717](https://github.com/filecoin-project/lotus/pull/12717))
 
 # UNRELEASED v.1.32.0
 
-
 See https://github.com/filecoin-project/lotus/blob/release/v1.32.0/CHANGELOG.md
 
 # Node and Miner v1.31.0 / 2024-12-02

Makefile

@@ -348,7 +348,6 @@ snap: lotus lotus-miner lotus-worker
 	snapcraft
 	# snapcraft upload ./lotus_*.snap
 
-# separate from gen because it needs binaries
 docsgen-cli: lotus lotus-miner lotus-worker
 	$(GOCC) run ./scripts/docsgen-cli
 	./lotus config default > documentation/en/default-lotus-config.toml

cli/cmd.go

@@ -57,10 +57,10 @@ var GetStorageMinerAPI = cliutil.GetStorageMinerAPI
 var GetWorkerAPI = cliutil.GetWorkerAPI
 
 var CommonCommands = []*cli.Command{
-	AuthCmd,
-	LogCmd,
-	WaitApiCmd,
-	FetchParamCmd,
+	WithCategory("developer", AuthCmd),
+	WithCategory("developer", LogCmd),
+	WithCategory("developer", WaitApiCmd),
+	WithCategory("developer", FetchParamCmd),
 	PprofCmd,
 	VersionCmd,
 }

cmd/lotus/backup.go renamed to cli/lotus/backup.go

@@ -1,4 +1,4 @@
-package main
+package lotus
 
 import (
 	"os"

cmd/lotus/config.go renamed to cli/lotus/config.go

@@ -1,4 +1,4 @@
-package main
+package lotus
 
 import (
 	"fmt"

cmd/lotus/daemon.go renamed to cli/lotus/daemon.go

@@ -1,7 +1,7 @@
 //go:build !nodaemon
 // +build !nodaemon
 
-package main
+package lotus
 
 import (
 	"bufio"

cmd/lotus/daemon_nodaemon.go renamed to cli/lotus/daemon_nodaemon.go

@@ -1,7 +1,7 @@
 //go:build nodaemon
 // +build nodaemon
 
-package main
+package lotus
 
 import (
 	"errors"

cmd/lotus/debug_advance.go renamed to cli/lotus/debug_advance.go

@@ -1,7 +1,7 @@
 //go:build debug
 // +build debug
 
-package main
+package lotus
 
 import (
 	"encoding/binary"

cli/lotus/lotus.go

@@ -0,0 +1,123 @@
+package lotus
+
+import (
+	"context"
+	"os"
+
+	"github.com/fatih/color"
+	logging "github.com/ipfs/go-log/v2"
+	"github.com/mattn/go-isatty"
+	"github.com/urfave/cli/v2"
+	"go.opencensus.io/trace"
+
+	"github.com/filecoin-project/lotus/api"
+	"github.com/filecoin-project/lotus/build"
+	"github.com/filecoin-project/lotus/cli/clicommands"
+	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"
+)
+
+var log = logging.Logger("lotus")
+
+var AdvanceBlockCmd *cli.Command
+
+func App() *cli.App {
+	api.RunningNodeType = api.NodeFull
+
+	lotuslog.SetupLogLevels()
+
+	local := []*cli.Command{
+		DaemonCmd,
+		backupCmd,
+		configCmd,
+	}
+	if AdvanceBlockCmd != nil {
+		local = append(local, AdvanceBlockCmd)
+	}
+
+	jaeger := tracing.SetupJaegerTracing("lotus")
+	defer func() {
+		if jaeger != nil {
+			_ = jaeger.ForceFlush(context.Background())
+		}
+	}()
+
+	for _, cmd := range local {
+		cmd := cmd
+		originBefore := cmd.Before
+		cmd.Before = func(cctx *cli.Context) error {
+			if jaeger != nil {
+				_ = jaeger.Shutdown(cctx.Context)
+			}
+			jaeger = tracing.SetupJaegerTracing("lotus/" + cmd.Name)
+
+			if cctx.IsSet("color") {
+				color.NoColor = !cctx.Bool("color")
+			}
+
+			if originBefore != nil {
+				return originBefore(cctx)
+			}
+			return nil
+		}
+	}
+	ctx, span := trace.StartSpan(context.Background(), "/cli")
+	defer span.End()
+
+	interactiveDef := isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd())
+
+	app := &cli.App{
+		Name:                 "lotus",
+		Usage:                "Filecoin decentralized storage network client",
+		Version:              string(build.NodeUserVersion()),
+		EnableBashCompletion: true,
+		Flags: []cli.Flag{
+			&cli.StringFlag{
+				Name:    "panic-reports",
+				EnvVars: []string{"LOTUS_PANIC_REPORT_PATH"},
+				Hidden:  true,
+				Value:   "~/.lotus", // should follow --repo default
+			},
+			&cli.BoolFlag{
+				// examined in the Before above
+				Name:        "color",
+				Usage:       "use color in display output",
+				DefaultText: "depends on output being a TTY",
+			},
+			&cli.StringFlag{
+				Name:    "repo",
+				EnvVars: []string{"LOTUS_PATH"},
+				Hidden:  true,
+				Value:   "~/.lotus", // TODO: Consider XDG_DATA_HOME
+			},
+			&cli.BoolFlag{
+				Name:  "interactive",
+				Usage: "setting to false will disable interactive functionality of commands",
+				Value: interactiveDef,
+			},
+			&cli.BoolFlag{
+				Name:  "force-send",
+				Usage: "if true, will ignore pre-send checks",
+			},
+			cliutil.FlagVeryVerbose,
+		},
+		After: func(c *cli.Context) error {
+			if r := recover(); r != nil {
+				// Generate report in LOTUS_PATH and re-raise panic
+				build.GenerateNodePanicReport(c.String("panic-reports"), c.String("repo"), c.App.Name)
+				panic(r)
+			}
+			return nil
+		},
+
+		Commands: append(local, clicommands.Commands...),
+	}
+
+	app.Setup()
+	app.Metadata["traceContext"] = ctx
+	app.Metadata["repoType"] = repo.FullNode
+
+	return app
+}

cmd/lotus-miner/actor.go renamed to cli/miner/actor.go

@@ -1,4 +1,4 @@
-package main
+package miner
 
 import (
 	"fmt"