diff --git a/README.md b/README.md index 77a967b..42e6bbb 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,8 @@ `raiju` is a CLI app which sits on top of a lightning node and brings some smarts (perhaps that is debateable) to the channel life-cycle: open, manage, and close. `raiju` only supports the [lnd](https://github.com/lightningnetwork/lnd) node implementation at the moment. -- [commands](#commands) +- [dashboard](#dashboard) +- [subcommands](#subcommands) - [candidates](#candidates) - [fees](#fees) - [rebalance](#rebalance) @@ -21,9 +22,13 @@ - [configuration](#configuration) - [node](#node) -# commands +# dashboard -All of `raiju`'s commands can be listed with the global help flag, `raiju -h`, and each command has its own help (e.g. `raiju candidates -h`). +`raiju`'s root command, `raiju`, fires up an interactive TUI dashboard. + +# subcommands + +All of `raiju`'s subcommands can be listed with the global help flag, `raiju -h`, and each command has its own help (e.g. `raiju candidates -h`). ## candidates diff --git a/cmd/raiju/raiju.go b/cmd/raiju/raiju.go index 5cf9c19..ecf65a3 100644 --- a/cmd/raiju/raiju.go +++ b/cmd/raiju/raiju.go @@ -345,8 +345,10 @@ func main() { } root := &ffcli.Command{ - ShortUsage: "raiju [global flags] [subcommand flags] [subcommand args]", + ShortUsage: "raiju [global flags] [subcommand] [subcommand flags] [subcommand args]", FlagSet: rootFlagSet, + ShortHelp: "Interactive dashboard", + LongHelp: "If given no subcommand, fire up an interactive dashboard that uses the subcommands under the hood.", Subcommands: []*ffcli.Command{candidatesCmd, feesCmd, rebalanceCmd, reaperCmd}, Options: []ff.Option{ff.WithEnvVarPrefix("RAIJU"), ff.WithConfigFileFlag("config"), ff.WithConfigFileParser(ff.PlainParser), ff.WithAllowMissingConfigFile(true)}, Exec: func(ctx context.Context, args []string) error {