Skip to content

Commit

Permalink
Regenerate CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@masih
masih committed Nov 14, 2024
1 parent 5240b88 commit 2b7ec90
Show file tree
Hide file tree
Showing 2 changed files with 190 additions and 17 deletions.
18 changes: 8 additions & 10 deletions cli/f3.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,7 @@ var (
{
Name: "list-miners",
Aliases: []string{"lm"},
Usage: `Lists the miners that currently participate in F3 via this node.
The instance may be specified as the first argument. If unspecified,
the latest instance is used.
`,
Usage: `Lists the miners that currently participate in F3 via this node.`,
Action: func(cctx *cli.Context) error {
api, closer, err := GetFullNodeAPIV1(cctx)
if err != nil {
Expand Down Expand Up @@ -84,9 +80,12 @@ the latest instance is used.
Aliases: []string{"pt"},
Subcommands: []*cli.Command{
{
Name: "get",
Aliases: []string{"g"},
Usage: "Get F3 power table at a specific instance ID or latest instance if none is specified.",
Name: "get",
Aliases: []string{"g"},
Usage: `Get F3 power table at a specific instance ID or latest instance if none is specified.
The instance may be specified as the first argument. If unspecified,
the latest instance is used.`,
ArgsUsage: "[instance]",
Flags: []cli.Flag{f3FlagPowerTableFromEC},
Before: func(cctx *cli.Context) error {
Expand Down Expand Up @@ -184,8 +183,7 @@ the latest instance is used.
The list of actors may be specified as Actor ID or miner address, space
separated, pied to STDIN. Example:
$ echo "1413 t01234 f12345" | lotus f3 powertable get-proportion 42
`,
$ echo "1413 t01234 f12345" | lotus f3 powertable get-proportion 42`,
ArgsUsage: "[instance]",
Flags: []cli.Flag{f3FlagPowerTableFromEC},
Before: func(cctx *cli.Context) error {
Expand Down
189 changes: 182 additions & 7 deletions documentation/en/cli-lotus.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2799,10 +2799,6 @@ USAGE:
COMMANDS:
list-miners, lm Lists the miners that currently participate in F3 via this node.
The instance may be specified as the first argument. If unspecified,
the latest instance is used.
powertable, pt
certs, c Manages interactions with F3 finality certificates.
manifest Gets the current manifest used by F3.
Expand All @@ -2818,12 +2814,191 @@ OPTIONS:
NAME:
lotus f3 list-miners - Lists the miners that currently participate in F3 via this node.
The instance may be specified as the first argument. If unspecified,
the latest instance is used.
USAGE:
lotus f3 list-miners [command options] [arguments...]
OPTIONS:
--help, -h show help
```

### lotus f3 powertable
```
NAME:
lotus f3 powertable
USAGE:
lotus f3 list-miners [command options] [arguments...]
lotus f3 powertable command [command options] [arguments...]
COMMANDS:
get, g Get F3 power table at a specific instance ID or latest instance if none is specified.
The instance may be specified as the first argument. If unspecified,
the latest instance is used.
get-proportion, gp Gets the total proportion of power for a list of actors at a given instance.
The instance may be specified as the first argument. If unspecified,
the latest instance is used.
The list of actors may be specified as Actor ID or miner address, space
separated, pied to STDIN. Example:
$ echo "1413 t01234 f12345" | lotus f3 powertable get-proportion 42
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help
```

#### lotus f3 powertable get
```
NAME:
lotus f3 powertable get - Get F3 power table at a specific instance ID or latest instance if none is specified.
The instance may be specified as the first argument. If unspecified,
the latest instance is used.
USAGE:
lotus f3 powertable get [command options] [instance]
OPTIONS:
--ec Whether to get the power table from EC. (default: false)
--help, -h show help
```

### lotus f3 certs
```
NAME:
lotus f3 certs - Manages interactions with F3 finality certificates.
USAGE:
lotus f3 certs command [command options] [arguments...]
COMMANDS:
get Gets an F3 finality certificate to a given instance ID, or the latest certificate if no instance is specified.
list Lists a range of F3 finality certificates.
By default the certificates are listed in newest to oldest order,
i.e. descending instance IDs. The order may be reversed using the
'--reverse' flag.
A range may optionally be specified as the first argument to indicate
inclusive range of 'from' and 'to' instances in following notation:
'<from>..<to>'. Either <from> or <to> may be omitted, but not both.
An omitted <from> value is always interpreted as 0, and an omitted
<to> value indicates the latest instance. If both are specified, <from>
must never exceed <to>.
If no range is specified, the latest 10 certificates are listed, i.e.
the range of '0..' with limit of 10. Otherwise, all certificates in
the specified range are listed unless limit is explicitly specified.
Examples:
* All certificates from newest to oldest:
$ lotus f3 certs list 0..
* Three newest certificates:
$ lotus f3 certs list --limit 3 0..
* Three oldest certificates:
$ lotus f3 certs list --limit 3 --reverse 0..
* Up to three certificates starting from instance 1413 to the oldest:
$ lotus f3 certs list --limit 3 ..1413
* Up to 3 certificates starting from instance 1413 to the newest:
$ lotus f3 certs list --limit 3 --reverse 1413..
* All certificates from instance 3 to 1413 in order of newest to oldest:
$ lotus f3 certs list 3..1413
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help
```

#### lotus f3 certs get
```
NAME:
lotus f3 certs get - Gets an F3 finality certificate to a given instance ID, or the latest certificate if no instance is specified.
USAGE:
lotus f3 certs get [command options] [instance]
OPTIONS:
--output value The output format. Supported formats: text, json (default: "text")
--help, -h show help
```

#### lotus f3 certs list
```
NAME:
lotus f3 certs list - Lists a range of F3 finality certificates.
By default the certificates are listed in newest to oldest order,
i.e. descending instance IDs. The order may be reversed using the
'--reverse' flag.
A range may optionally be specified as the first argument to indicate
inclusive range of 'from' and 'to' instances in following notation:
'<from>..<to>'. Either <from> or <to> may be omitted, but not both.
An omitted <from> value is always interpreted as 0, and an omitted
<to> value indicates the latest instance. If both are specified, <from>
must never exceed <to>.
If no range is specified, the latest 10 certificates are listed, i.e.
the range of '0..' with limit of 10. Otherwise, all certificates in
the specified range are listed unless limit is explicitly specified.
Examples:
* All certificates from newest to oldest:
$ lotus f3 certs list 0..
* Three newest certificates:
$ lotus f3 certs list --limit 3 0..
* Three oldest certificates:
$ lotus f3 certs list --limit 3 --reverse 0..
* Up to three certificates starting from instance 1413 to the oldest:
$ lotus f3 certs list --limit 3 ..1413
* Up to 3 certificates starting from instance 1413 to the newest:
$ lotus f3 certs list --limit 3 --reverse 1413..
* All certificates from instance 3 to 1413 in order of newest to oldest:
$ lotus f3 certs list 3..1413
USAGE:
lotus f3 certs list [command options] [range]
OPTIONS:
--output value The output format. Supported formats: text, json (default: "text")
--limit value The maximum number of instances. A value less than 0 indicates no limit. (default: 10 when no range is specified. Otherwise, unlimited.)
--reverse Reverses the default order of output. (default: false)
--help, -h show help
```

### lotus f3 manifest
```
NAME:
lotus f3 manifest - Gets the current manifest used by F3.
USAGE:
lotus f3 manifest [command options] [arguments...]
OPTIONS:
--output value The output format. Supported formats: text, json (default: "text")
--help, -h show help
```

### lotus f3 status
```
NAME:
lotus f3 status - Checks the F3 status.
USAGE:
lotus f3 status [command options] [arguments...]
OPTIONS:
--help, -h show help
Expand Down

0 comments on commit 2b7ec90

Please sign in to comment.