mirror of
https://github.com/rclone/rclone.git
synced 2024-11-22 08:23:47 +01:00
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/
45 lines
992 B
Go
45 lines
992 B
Go
// Package ls provides the ls command.
|
|
package ls
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
|
|
"github.com/rclone/rclone/cmd"
|
|
"github.com/rclone/rclone/cmd/ls/lshelp"
|
|
"github.com/rclone/rclone/fs/operations"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func init() {
|
|
cmd.Root.AddCommand(commandDefinition)
|
|
}
|
|
|
|
var commandDefinition = &cobra.Command{
|
|
Use: "ls remote:path",
|
|
Short: `List the objects in the path with size and path.`,
|
|
Long: `
|
|
Lists the objects in the source path to standard output in a human
|
|
readable format with size and path. Recurses by default.
|
|
|
|
Eg
|
|
|
|
$ rclone ls swift:bucket
|
|
60295 bevajer5jef
|
|
90613 canole
|
|
94467 diwogej7
|
|
37600 fubuwic
|
|
|
|
` + lshelp.Help,
|
|
Annotations: map[string]string{
|
|
"groups": "Filter,Listing",
|
|
},
|
|
Run: func(command *cobra.Command, args []string) {
|
|
cmd.CheckArgs(1, 1, command, args)
|
|
fsrc := cmd.NewFsSrc(args)
|
|
cmd.Run(false, false, command, func() error {
|
|
return operations.List(context.Background(), fsrc, os.Stdout)
|
|
})
|
|
},
|
|
}
|