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/
66 lines
1.8 KiB
Go
66 lines
1.8 KiB
Go
// Package lsd provides the lsd command.
|
|
package lsd
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
|
|
"github.com/rclone/rclone/cmd"
|
|
"github.com/rclone/rclone/cmd/ls/lshelp"
|
|
"github.com/rclone/rclone/fs"
|
|
"github.com/rclone/rclone/fs/config/flags"
|
|
"github.com/rclone/rclone/fs/operations"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
recurse bool
|
|
)
|
|
|
|
func init() {
|
|
cmd.Root.AddCommand(commandDefinition)
|
|
cmdFlags := commandDefinition.Flags()
|
|
flags.BoolVarP(cmdFlags, &recurse, "recursive", "R", false, "Recurse into the listing", "")
|
|
}
|
|
|
|
var commandDefinition = &cobra.Command{
|
|
Use: "lsd remote:path",
|
|
Short: `List all directories/containers/buckets in the path.`,
|
|
Long: `
|
|
Lists the directories in the source path to standard output. Does not
|
|
recurse by default. Use the ` + "`-R`" + ` flag to recurse.
|
|
|
|
This command lists the total size of the directory (if known, -1 if
|
|
not), the modification time (if known, the current time if not), the
|
|
number of objects in the directory (if known, -1 if not) and the name
|
|
of the directory, Eg
|
|
|
|
$ rclone lsd swift:
|
|
494000 2018-04-26 08:43:20 10000 10000files
|
|
65 2018-04-26 08:43:20 1 1File
|
|
|
|
Or
|
|
|
|
$ rclone lsd drive:test
|
|
-1 2016-10-17 17:41:53 -1 1000files
|
|
-1 2017-01-03 14:40:54 -1 2500files
|
|
-1 2017-07-08 14:39:28 -1 4000files
|
|
|
|
If you just want the directory names use ` + "`rclone lsf --dirs-only`" + `.
|
|
|
|
` + lshelp.Help,
|
|
Annotations: map[string]string{
|
|
"groups": "Filter,Listing",
|
|
},
|
|
Run: func(command *cobra.Command, args []string) {
|
|
ci := fs.GetConfig(context.Background())
|
|
cmd.CheckArgs(1, 1, command, args)
|
|
if recurse {
|
|
ci.MaxDepth = 0
|
|
}
|
|
fsrc := cmd.NewFsSrc(args)
|
|
cmd.Run(false, false, command, func() error {
|
|
return operations.ListDir(context.Background(), fsrc, os.Stdout)
|
|
})
|
|
},
|
|
}
|