Skip to content

Commit

Permalink
Add dashboard docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nyonson committed Apr 12, 2023
1 parent 9e491eb commit b103efb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down
4 changes: 3 additions & 1 deletion cmd/raiju/raiju.go
Original file line number Diff line number Diff line change
Expand Up @@ -345,8 +345,10 @@ func main() {
}

root := &ffcli.Command{
ShortUsage: "raiju [global flags] <subcommand> [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 {
Expand Down

0 comments on commit b103efb

Please sign in to comment.