Merge pull request #236 from jameskim0987/issue-227-add-docs-cli-flag

[ISSUE-227] add `docs` CLI command

cmd/main.go

@@ -66,6 +66,11 @@ func main() {
 			Flags:  append(config.ForkCLIFlags(envVarPrefix), baseFlags...),
 			Action: cliapp.LifecycleCmd(SupersimMain),
 		},
+		{
+			Name:   config.DocsCommandName,
+			Usage:  "Display available docs links",
+			Action: cliapp.LifecycleCmd(SupersimMain),
+		},
 	}
 
 	ctx := ctxinterrupt.WithSignalWaiterMain(context.Background())
@@ -89,6 +94,12 @@ func SupersimMain(ctx *cli.Context, closeApp context.CancelCauseFunc) (cliapp.Li
 		return nil, fmt.Errorf("invalid cli config: %w", err)
 	}
 
+	if ctx.Command.Name == config.DocsCommandName {
+		config.PrintDocLinks()
+		closeApp(nil)
+		os.Exit(0)
+	}
+
 	// use config and setup supersim
 	s, err := supersim.NewSupersim(log, envVarPrefix, closeApp, cfg)
 	if err != nil {

config/cli.go

@@ -13,6 +13,7 @@ import (
 
 const (
 	ForkCommandName = "fork"
+	DocsCommandName = "docs"
 
 	AdminPortFlagName = "admin.port"
 
@@ -29,6 +30,15 @@ const (
 	InteropAutoRelayFlagName = "interop.autorelay"
 )
 
+var documentationLinks = []struct {
+	url  string
+	text string
+}{
+	{"https://specs.optimism.io/interop/overview.html", "Superchain Interop Specs"},
+	{"https://docs.optimism.io/", "Optimism Documentation"},
+	{"https://supersim.pages.dev/", "Supersim Documentation"},
+}
+
 func BaseCLIFlags(envPrefix string) []cli.Flag {
 	return []cli.Flag{
 		&cli.Uint64Flag{
@@ -167,3 +177,11 @@ func (c *CLIConfig) Check() error {
 
 	return nil
 }
+
+func PrintDocLinks() {
+	fmt.Printf("Here are the available documentation links:\n\n")
+
+	for _, link := range documentationLinks {
+		fmt.Printf("\033]8;;%s\033\\%s\033]8;;\033\\\n", link.url, link.text)
+	}
+}