bff702a6f1
This adds an additional parameter to the creation of each flag. This specifies one or more flag groups. This **must** be set for global flags and **must not** be set for local flags. This causes flags.md to be built with sections to aid comprehension and it causes the documentation pages for each command (and the `--help`) to be built showing the flags groups as specified in the `groups` annotation on the command. See: https://forum.rclone.org/t/make-docs-for-mortals-not-only-rclone-gurus/39476/
55 lines
1.3 KiB
Go
55 lines
1.3 KiB
Go
// Package ls provides the ls command.
|
|
package ls
|
|
|
|
import (
|
|
"fmt"
|
|
"sort"
|
|
|
|
"github.com/rclone/rclone/cmd"
|
|
"github.com/rclone/rclone/fs/config"
|
|
"github.com/rclone/rclone/fs/config/flags"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// Globals
|
|
var (
|
|
listLong bool
|
|
)
|
|
|
|
func init() {
|
|
cmd.Root.AddCommand(commandDefinition)
|
|
cmdFlags := commandDefinition.Flags()
|
|
flags.BoolVarP(cmdFlags, &listLong, "long", "", listLong, "Show the type as well as names", "")
|
|
}
|
|
|
|
var commandDefinition = &cobra.Command{
|
|
Use: "listremotes",
|
|
Short: `List all the remotes in the config file and defined in environment variables.`,
|
|
Long: `
|
|
rclone listremotes lists all the available remotes from the config file.
|
|
|
|
When used with the ` + "`--long`" + ` flag it lists the types too.
|
|
`,
|
|
Annotations: map[string]string{
|
|
"versionIntroduced": "v1.34",
|
|
},
|
|
Run: func(command *cobra.Command, args []string) {
|
|
cmd.CheckArgs(0, 0, command, args)
|
|
remotes := config.FileSections()
|
|
sort.Strings(remotes)
|
|
maxlen := 1
|
|
for _, remote := range remotes {
|
|
if len(remote) > maxlen {
|
|
maxlen = len(remote)
|
|
}
|
|
}
|
|
for _, remote := range remotes {
|
|
if listLong {
|
|
remoteType := config.FileGet(remote, "type")
|
|
fmt.Printf("%-*s %s\n", maxlen+1, remote+":", remoteType)
|
|
} else {
|
|
fmt.Printf("%s:\n", remote)
|
|
}
|
|
}
|
|
},
|
|
}
|