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/
34 lines
821 B
Go
34 lines
821 B
Go
// Package cleanup provides the cleanup command.
|
|
package cleanup
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/rclone/rclone/cmd"
|
|
"github.com/rclone/rclone/fs/operations"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func init() {
|
|
cmd.Root.AddCommand(commandDefinition)
|
|
}
|
|
|
|
var commandDefinition = &cobra.Command{
|
|
Use: "cleanup remote:path",
|
|
Short: `Clean up the remote if possible.`,
|
|
Long: `
|
|
Clean up the remote if possible. Empty the trash or delete old file
|
|
versions. Not supported by all remotes.
|
|
`,
|
|
Annotations: map[string]string{
|
|
"versionIntroduced": "v1.31",
|
|
"groups": "Important",
|
|
},
|
|
Run: func(command *cobra.Command, args []string) {
|
|
cmd.CheckArgs(1, 1, command, args)
|
|
fsrc := cmd.NewFsSrc(args)
|
|
cmd.Run(true, false, command, func() error {
|
|
return operations.CleanUp(context.Background(), fsrc)
|
|
})
|
|
},
|
|
}
|