cerc-io/lotus
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity

Merge pull request #8587 from filecoin-project/gstuart/cli-uniformity

Browse Source 
chore: cli: Alias cli commands for uniformity
This commit is contained in:
Geoff Stuart 2022-05-04 13:21:17 -04:00 committed by GitHub
commit 27e99ff84f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 122 additions and 208 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cli/chain.go
View File

@ -90,7 +90,8 @@ var ChainHeadCmd = &cli.Command{
} }
var ChainGetBlock = &cli.Command{ var ChainGetBlock = &cli.Command{
Name: "getblock", Name: "get-block",
Aliases: []string{"getblock"},
Usage: "Get a block and print its details", Usage: "Get a block and print its details",
ArgsUsage: "[blockCid]", ArgsUsage: "[blockCid]",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -299,6 +300,7 @@ var ChainStatObjCmd = &cli.Command{
var ChainGetMsgCmd = &cli.Command{ var ChainGetMsgCmd = &cli.Command{
Name: "getmessage", Name: "getmessage",
Aliases: []string{"get-message", "get-msg"},
Usage: "Get and print a message by its cid", Usage: "Get and print a message by its cid",
ArgsUsage: "[messageCid]", ArgsUsage: "[messageCid]",
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {
@ -349,6 +351,7 @@ var ChainGetMsgCmd = &cli.Command{
var ChainSetHeadCmd = &cli.Command{ var ChainSetHeadCmd = &cli.Command{
Name: "sethead", Name: "sethead",
Aliases: []string{"set-head"},
Usage: "manually set the local nodes head tipset (Caution: normally only used for recovery)", Usage: "manually set the local nodes head tipset (Caution: normally only used for recovery)",
ArgsUsage: "[tipsetkey]", ArgsUsage: "[tipsetkey]",
Flags: []cli.Flag{ Flags: []cli.Flag{

3
cli/net.go
View File

@ -358,7 +358,8 @@ var NetId = &cli.Command{
} }
var NetFindPeer = &cli.Command{ var NetFindPeer = &cli.Command{
Name: "findpeer", Name: "find-peer",
Aliases: []string{"findpeer"},
Usage: "Find the addresses of a given peerID", Usage: "Find the addresses of a given peerID",
ArgsUsage: "[peerId]", ArgsUsage: "[peerId]",
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {

3
cli/state.go
View File

@ -1428,6 +1428,7 @@ func jsonReturn(code cid.Cid, method abi.MethodNum, ret []byte) (string, error)
var StateWaitMsgCmd = &cli.Command{ var StateWaitMsgCmd = &cli.Command{
Name: "wait-msg", Name: "wait-msg",
Aliases: []string{"wait-message"},
Usage: "Wait for a message to appear on chain", Usage: "Wait for a message to appear on chain",
ArgsUsage: "[messageCid]", ArgsUsage: "[messageCid]",
Flags: []cli.Flag{ Flags: []cli.Flag{
@ -1470,6 +1471,7 @@ var StateWaitMsgCmd = &cli.Command{
var StateSearchMsgCmd = &cli.Command{ var StateSearchMsgCmd = &cli.Command{
Name: "search-msg", Name: "search-msg",
Aliases: []string{"search-message"},
Usage: "Search to see whether a message has appeared on chain", Usage: "Search to see whether a message has appeared on chain",
ArgsUsage: "[messageCid]", ArgsUsage: "[messageCid]",
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {
@ -1727,6 +1729,7 @@ var StateCircSupplyCmd = &cli.Command{
var StateSectorCmd = &cli.Command{ var StateSectorCmd = &cli.Command{
Name: "sector", Name: "sector",
Aliases: []string{"sector-info"},
Usage: "Get miner sector info", Usage: "Get miner sector info",
ArgsUsage: "[minerAddress] [sectorNumber]", ArgsUsage: "[minerAddress] [sectorNumber]",
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {

5
cmd/lotus-miner/actor.go
View File

@ -51,8 +51,9 @@ var actorCmd = &cli.Command{
} }
var actorSetAddrsCmd = &cli.Command{ var actorSetAddrsCmd = &cli.Command{
Name: "set-addrs", Name: "set-addresses",
Usage: "set addresses that your miner can be publicly dialed on", Aliases: []string{"set-addrs"},
Usage: "set addresses that your miner can be publicly dialed on",
Flags: []cli.Flag{ Flags: []cli.Flag{
&cli.Int64Flag{ &cli.Int64Flag{
Name: "gas-limit", Name: "gas-limit",

5
cmd/lotus-miner/proving.go
View File

@ -522,8 +522,9 @@ var provingComputeCmd = &cli.Command{
} }
var provingComputeWindowPoStCmd = &cli.Command{ var provingComputeWindowPoStCmd = &cli.Command{
Name: "window-post", Name: "windowed-post",
Usage: "Compute WindowPoSt for a specific deadline", Aliases: []string{"window-post"},
Usage: "Compute WindowPoSt for a specific deadline",
Description: `Note: This command is intended to be used to verify PoSt compute performance. Description: `Note: This command is intended to be used to verify PoSt compute performance.
It will not send any messages to the chain.`, It will not send any messages to the chain.`,
ArgsUsage: "[deadline index]", ArgsUsage: "[deadline index]",

3
cmd/lotus-shed/blockmsgid.go
View File

@ -14,7 +14,8 @@ import (
) )
var blockmsgidCmd = &cli.Command{ var blockmsgidCmd = &cli.Command{
Name: "blockmsgid", Name: "block-message-id",
Aliases: []string{"blockmsgid"},
Usage: "Print a block's pubsub message ID", Usage: "Print a block's pubsub message ID",
ArgsUsage: "<blockCid> ...", ArgsUsage: "<blockCid> ...",
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {

5
cmd/lotus-shed/keyinfo.go
View File

@ -41,8 +41,9 @@ type keyInfoOutput struct {
} }
var keyinfoCmd = &cli.Command{ var keyinfoCmd = &cli.Command{
Name: "keyinfo", Name: "key-info",
Usage: "work with lotus keyinfo files (wallets and libp2p host keys)", Aliases: []string{"keyinfo"},
Usage: "work with lotus keyinfo files (wallets and libp2p host keys)",
Description: `The subcommands of keyinfo provide helpful tools for working with keyinfo files without Description: `The subcommands of keyinfo provide helpful tools for working with keyinfo files without
having to run the lotus daemon.`, having to run the lotus daemon.`,
Subcommands: []*cli.Command{ Subcommands: []*cli.Command{

2
cmd/lotus-shed/miner.go
View File

@ -119,7 +119,7 @@ var minerFaultsCmd = &cli.Command{
var minerCreateCmd = &cli.Command{ var minerCreateCmd = &cli.Command{
Name: "create", Name: "create",
Usage: "sends a create miner msg", Usage: "sends a create miner message",
ArgsUsage: "[sender] [owner] [worker] [sector size]", ArgsUsage: "[sender] [owner] [worker] [sector size]",
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {
wapi, closer, err := lcli.GetFullNodeAPI(cctx) wapi, closer, err := lcli.GetFullNodeAPI(cctx)

3
cmd/lotus-shed/mpool.go
View File

@ -20,7 +20,8 @@ var mpoolCmd = &cli.Command{
} }
var minerSelectMsgsCmd = &cli.Command{ var minerSelectMsgsCmd = &cli.Command{
Name: "miner-select-msgs", Name: "miner-select-messages",
Aliases: []string{"miner-select-msgs"},
Flags: []cli.Flag{ Flags: []cli.Flag{
&cli.Float64Flag{ &cli.Float64Flag{
Name: "ticket-quality", Name: "ticket-quality",

3
cmd/lotus-shed/msg.go
View File

@ -22,7 +22,8 @@ import (
) )
var msgCmd = &cli.Command{ var msgCmd = &cli.Command{
Name: "msg", Name: "message",
Aliases: []string{"msg"},
Usage: "Translate message between various formats", Usage: "Translate message between various formats",
ArgsUsage: "Message in any form", ArgsUsage: "Message in any form",
Action: func(cctx *cli.Context) error { Action: func(cctx *cli.Context) error {

1
cmd/lotus-sim/info_message.go
View File

@ -16,6 +16,7 @@ import (
var infoMessageSizeSimCommand = &cli.Command{ var infoMessageSizeSimCommand = &cli.Command{
Name: "message-size", Name: "message-size",
Aliases: []string{"msg-size"},
Description: "Output information about message size distribution", Description: "Output information about message size distribution",
Flags: []cli.Flag{ Flags: []cli.Flag{
&cli.Int64Flag{ &cli.Int64Flag{

95
documentation/en/cli-lotus-miner.md
View File

@ -236,35 +236,24 @@ USAGE:
lotus-miner actor command [command options] [arguments...] lotus-miner actor command [command options] [arguments...]
COMMANDS: COMMANDS:
set-addrs set addresses that your miner can be publicly dialed on set-addresses, set-addrs set addresses that your miner can be publicly dialed on
withdraw withdraw available balance withdraw withdraw available balance
repay-debt pay down a miner's debt repay-debt pay down a miner's debt
set-peer-id set the peer id of your miner set-peer-id set the peer id of your miner
set-owner Set owner address (this command should be invoked twice, first with the old owner as the senderAddress, and then with the new owner) set-owner Set owner address (this command should be invoked twice, first with the old owner as the senderAddress, and then with the new owner)
control Manage control addresses control Manage control addresses
propose-change-worker Propose a worker address change propose-change-worker Propose a worker address change
confirm-change-worker Confirm a worker address change confirm-change-worker Confirm a worker address change
compact-allocated compact allocated sectors bitfield compact-allocated compact allocated sectors bitfield
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
OPTIONS: OPTIONS:
--help, -h show help (default: false) --help, -h show help (default: false)
``` ```
### lotus-miner actor set-addrs #### lotus-miner actor set-addresses, set-addrs
``` ```
NAME:
lotus-miner actor set-addrs - set addresses that your miner can be publicly dialed on
USAGE:
lotus-miner actor set-addrs [command options] [arguments...]
OPTIONS:
--gas-limit value set gas limit (default: 0)
--unset unset address (default: false)
--help, -h show help (default: false)
``` ```
### lotus-miner actor withdraw ### lotus-miner actor withdraw
@ -1199,22 +1188,22 @@ USAGE:
lotus-miner net command [command options] [arguments...] lotus-miner net command [command options] [arguments...]
COMMANDS: COMMANDS:
peers Print peers peers Print peers
ping Ping peers ping Ping peers
connect Connect to a peer connect Connect to a peer
listen List listen addresses listen List listen addresses
id Get node identity id Get node identity
findpeer Find the addresses of a given peerID find-peer, findpeer Find the addresses of a given peerID
scores Print peers' pubsub scores scores Print peers' pubsub scores
reachability Print information about reachability from the internet reachability Print information about reachability from the internet
bandwidth Print bandwidth usage information bandwidth Print bandwidth usage information
block Manage network connection gating rules block Manage network connection gating rules
stat Report resource usage for a scope stat Report resource usage for a scope
limit Get or set resource limits for a scope limit Get or set resource limits for a scope
protect Add one or more peer IDs to the list of protected peer connections protect Add one or more peer IDs to the list of protected peer connections
unprotect Remove one or more peer IDs from the list of protected peer connections. unprotect Remove one or more peer IDs from the list of protected peer connections.
list-protected List the peer IDs with protected connection. list-protected List the peer IDs with protected connection.
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
OPTIONS: OPTIONS:
--help, -h show help (default: false) --help, -h show help (default: false)
@ -1290,17 +1279,8 @@ OPTIONS:
``` ```
### lotus-miner net findpeer #### lotus-miner net find-peer, findpeer
``` ```
NAME:
lotus-miner net findpeer - Find the addresses of a given peerID
USAGE:
lotus-miner net findpeer [command options] [peerId]
OPTIONS:
--help, -h show help (default: false)
``` ```
### lotus-miner net scores ### lotus-miner net scores
@ -2141,29 +2121,16 @@ USAGE:
lotus-miner proving compute command [command options] [arguments...] lotus-miner proving compute command [command options] [arguments...]
COMMANDS: COMMANDS:
window-post Compute WindowPoSt for a specific deadline windowed-post, window-post Compute WindowPoSt for a specific deadline
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
OPTIONS: OPTIONS:
--help, -h show help (default: false) --help, -h show help (default: false)
``` ```
#### lotus-miner proving compute window-post ##### lotus-miner proving compute windowed-post, window-post
``` ```
NAME:
lotus-miner proving compute window-post - Compute WindowPoSt for a specific deadline
USAGE:
lotus-miner proving compute window-post [command options] [deadline index]
DESCRIPTION:
Note: This command is intended to be used to verify PoSt compute performance.
It will not send any messages to the chain.
OPTIONS:
--help, -h show help (default: false)
``` ```
## lotus-miner storage ## lotus-miner storage

197
documentation/en/cli-lotus.md
View File

@ -1726,30 +1726,30 @@ USAGE:
lotus state command [command options] [arguments...] lotus state command [command options] [arguments...]
COMMANDS: COMMANDS:
power Query network or miner power power Query network or miner power
sectors Query the sector set of a miner sectors Query the sector set of a miner
active-sectors Query the active sector set of a miner active-sectors Query the active sector set of a miner
list-actors list all actors in the network list-actors list all actors in the network
list-miners list all miners in the network list-miners list all miners in the network
circulating-supply Get the exact current circulating supply of Filecoin circulating-supply Get the exact current circulating supply of Filecoin
sector Get miner sector info sector, sector-info Get miner sector info
get-actor Print actor information get-actor Print actor information
lookup Find corresponding ID address lookup Find corresponding ID address
replay Replay a particular message replay Replay a particular message
sector-size Look up miners sector size sector-size Look up miners sector size
read-state View a json representation of an actors state read-state View a json representation of an actors state
list-messages list messages on chain matching given criteria list-messages list messages on chain matching given criteria
compute-state Perform state computations compute-state Perform state computations
call Invoke a method on an actor locally call Invoke a method on an actor locally
get-deal View on-chain deal info get-deal View on-chain deal info
wait-msg Wait for a message to appear on chain wait-msg, wait-message Wait for a message to appear on chain
search-msg Search to see whether a message has appeared on chain search-msg, search-message Search to see whether a message has appeared on chain
miner-info Retrieve miner information miner-info Retrieve miner information
market Inspect the storage market actor market Inspect the storage market actor
exec-trace Get the execution trace of a given message exec-trace Get the execution trace of a given message
network-version Returns the network version network-version Returns the network version
miner-proving-deadline Retrieve information about a given miner's proving deadline miner-proving-deadline Retrieve information about a given miner's proving deadline
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
OPTIONS: OPTIONS:
--tipset value specify tipset to call method on (pass comma separated array of cids) --tipset value specify tipset to call method on (pass comma separated array of cids)
@ -1837,17 +1837,8 @@ OPTIONS:
``` ```
### lotus state sector #### lotus state sector, sector-info
``` ```
NAME:
lotus state sector - Get miner sector info
USAGE:
lotus state sector [command options] [minerAddress] [sectorNumber]
OPTIONS:
--help, -h show help (default: false)
``` ```
### lotus state get-actor ### lotus state get-actor
@ -1985,31 +1976,12 @@ OPTIONS:
``` ```
### lotus state wait-msg #### lotus state wait-msg, wait-message
``` ```
NAME:
lotus state wait-msg - Wait for a message to appear on chain
USAGE:
lotus state wait-msg [command options] [messageCid]
OPTIONS:
--timeout value (default: "10m")
--help, -h show help (default: false)
``` ```
### lotus state search-msg #### lotus state search-msg, search-message
``` ```
NAME:
lotus state search-msg - Search to see whether a message has appeared on chain
USAGE:
lotus state search-msg [command options] [messageCid]
OPTIONS:
--help, -h show help (default: false)
``` ```
### lotus state miner-info ### lotus state miner-info
@ -2103,24 +2075,24 @@ USAGE:
lotus chain command [command options] [arguments...] lotus chain command [command options] [arguments...]
COMMANDS: COMMANDS:
head Print chain head head Print chain head
getblock Get a block and print its details get-block, getblock Get a block and print its details
read-obj Read the raw bytes of an object read-obj Read the raw bytes of an object
delete-obj Delete an object from the chain blockstore delete-obj Delete an object from the chain blockstore
stat-obj Collect size and ipld link counts for objs stat-obj Collect size and ipld link counts for objs
getmessage Get and print a message by its cid getmessage, get-message, get-msg Get and print a message by its cid
sethead manually set the local nodes head tipset (Caution: normally only used for recovery) sethead, set-head manually set the local nodes head tipset (Caution: normally only used for recovery)
list, love View a segment of the chain list, love View a segment of the chain
get Get chain DAG node by path get Get chain DAG node by path
bisect bisect chain for an event bisect bisect chain for an event
export export chain to a car file export export chain to a car file
slash-consensus Report consensus fault slash-consensus Report consensus fault
gas-price Estimate gas prices gas-price Estimate gas prices
inspect-usage Inspect block space usage of a given tipset inspect-usage Inspect block space usage of a given tipset
decode decode various types decode decode various types
encode encode various types encode encode various types
disputer interact with the window post disputer disputer interact with the window post disputer
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
OPTIONS: OPTIONS:
--help, -h show help (default: false) --help, -h show help (default: false)
@ -2140,18 +2112,8 @@ OPTIONS:
``` ```
### lotus chain getblock #### lotus chain get-block, getblock
``` ```
NAME:
lotus chain getblock - Get a block and print its details
USAGE:
lotus chain getblock [command options] [blockCid]
OPTIONS:
--raw print just the raw block header (default: false)
--help, -h show help (default: false)
``` ```
### lotus chain read-obj ### lotus chain read-obj
@ -2204,32 +2166,12 @@ OPTIONS:
``` ```
### lotus chain getmessage ##### lotus chain getmessage, get-message, get-msg
``` ```
NAME:
lotus chain getmessage - Get and print a message by its cid
USAGE:
lotus chain getmessage [command options] [messageCid]
OPTIONS:
--help, -h show help (default: false)
``` ```
### lotus chain sethead #### lotus chain sethead, set-head
``` ```
NAME:
lotus chain sethead - manually set the local nodes head tipset (Caution: normally only used for recovery)
USAGE:
lotus chain sethead [command options] [tipsetkey]
OPTIONS:
--genesis reset head to genesis (default: false)
--epoch value reset head to given epoch (default: 0)
--help, -h show help (default: false)
``` ```
#### lotus chain list, love #### lotus chain list, love
@ -2602,22 +2544,22 @@ USAGE:
lotus net command [command options] [arguments...] lotus net command [command options] [arguments...]
COMMANDS: COMMANDS:
peers Print peers peers Print peers
ping Ping peers ping Ping peers
connect Connect to a peer connect Connect to a peer
listen List listen addresses listen List listen addresses
id Get node identity id Get node identity
findpeer Find the addresses of a given peerID find-peer, findpeer Find the addresses of a given peerID
scores Print peers' pubsub scores scores Print peers' pubsub scores
reachability Print information about reachability from the internet reachability Print information about reachability from the internet
bandwidth Print bandwidth usage information bandwidth Print bandwidth usage information
block Manage network connection gating rules block Manage network connection gating rules
stat Report resource usage for a scope stat Report resource usage for a scope
limit Get or set resource limits for a scope limit Get or set resource limits for a scope
protect Add one or more peer IDs to the list of protected peer connections protect Add one or more peer IDs to the list of protected peer connections
unprotect Remove one or more peer IDs from the list of protected peer connections. unprotect Remove one or more peer IDs from the list of protected peer connections.
list-protected List the peer IDs with protected connection. list-protected List the peer IDs with protected connection.
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
OPTIONS: OPTIONS:
--help, -h show help (default: false) --help, -h show help (default: false)
@ -2693,17 +2635,8 @@ OPTIONS:
``` ```
### lotus net findpeer #### lotus net find-peer, findpeer
``` ```
NAME:
lotus net findpeer - Find the addresses of a given peerID
USAGE:
lotus net findpeer [command options] [peerId]
OPTIONS:
--help, -h show help (default: false)
``` ```
### lotus net scores ### lotus net scores