seaweedfs/weed/command/command.go

78 lines
1.5 KiB
Go
Raw Normal View History

package command
import (
2013-01-17 08:56:56 +00:00
"flag"
"fmt"
"os"
"strings"
)
var Commands = []*Command{
cmdBenchmark,
cmdBackup,
cmdCompact,
cmdCopy,
cmdFix,
2018-09-17 07:27:56 +00:00
cmdFilerReplicate,
cmdServer,
cmdMaster,
cmdFiler,
2018-07-18 09:37:09 +00:00
cmdS3,
cmdUpload,
cmdDownload,
2020-03-04 08:39:47 +00:00
cmdMsgBroker,
2018-08-19 22:36:30 +00:00
cmdScaffold,
cmdShell,
cmdVersion,
cmdVolume,
cmdExport,
cmdMount,
cmdWebDav,
}
type Command struct {
2013-01-17 08:56:56 +00:00
// Run runs the command.
// The args are the arguments after the command name.
Run func(cmd *Command, args []string) bool
2013-01-17 08:56:56 +00:00
// UsageLine is the one-line usage message.
// The first word in the line is taken to be the command name.
UsageLine string
2013-01-17 08:56:56 +00:00
// Short is the short description shown in the 'go help' output.
Short string
2013-01-17 08:56:56 +00:00
// Long is the long message shown in the 'go help <this-command>' output.
Long string
2013-01-17 08:56:56 +00:00
// Flag is a set of flags specific to this command.
Flag flag.FlagSet
2013-01-20 03:49:57 +00:00
IsDebug *bool
}
// Name returns the command's name: the first word in the usage line.
func (c *Command) Name() string {
2013-01-17 08:56:56 +00:00
name := c.UsageLine
i := strings.Index(name, " ")
if i >= 0 {
name = name[:i]
}
return name
}
func (c *Command) Usage() {
2013-01-17 08:56:56 +00:00
fmt.Fprintf(os.Stderr, "Example: weed %s\n", c.UsageLine)
fmt.Fprintf(os.Stderr, "Default Usage:\n")
c.Flag.PrintDefaults()
fmt.Fprintf(os.Stderr, "Description:\n")
fmt.Fprintf(os.Stderr, " %s\n", strings.TrimSpace(c.Long))
os.Exit(2)
}
// Runnable reports whether the command can be run; otherwise
// it is a documentation pseudo-command such as importpath.
func (c *Command) Runnable() bool {
2013-01-17 08:56:56 +00:00
return c.Run != nil
}