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/
74 lines
2.2 KiB
Go
74 lines
2.2 KiB
Go
// Package delete provides the delete command.
|
|
package delete
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
|
|
"github.com/rclone/rclone/cmd"
|
|
"github.com/rclone/rclone/fs/config/flags"
|
|
"github.com/rclone/rclone/fs/operations"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
rmdirs = false
|
|
)
|
|
|
|
func init() {
|
|
cmd.Root.AddCommand(commandDefinition)
|
|
cmdFlags := commandDefinition.Flags()
|
|
flags.BoolVarP(cmdFlags, &rmdirs, "rmdirs", "", rmdirs, "rmdirs removes empty directories but leaves root intact", "")
|
|
}
|
|
|
|
var commandDefinition = &cobra.Command{
|
|
Use: "delete remote:path",
|
|
Short: `Remove the files in path.`,
|
|
// Warning! "|" will be replaced by backticks below
|
|
Long: strings.ReplaceAll(`
|
|
Remove the files in path. Unlike [purge](/commands/rclone_purge/) it
|
|
obeys include/exclude filters so can be used to selectively delete files.
|
|
|
|
|rclone delete| only deletes files but leaves the directory structure
|
|
alone. If you want to delete a directory and all of its contents use
|
|
the [purge](/commands/rclone_purge/) command.
|
|
|
|
If you supply the |--rmdirs| flag, it will remove all empty directories along with it.
|
|
You can also use the separate command [rmdir](/commands/rclone_rmdir/) or
|
|
[rmdirs](/commands/rclone_rmdirs/) to delete empty directories only.
|
|
|
|
For example, to delete all files bigger than 100 MiB, you may first want to
|
|
check what would be deleted (use either):
|
|
|
|
rclone --min-size 100M lsl remote:path
|
|
rclone --dry-run --min-size 100M delete remote:path
|
|
|
|
Then proceed with the actual delete:
|
|
|
|
rclone --min-size 100M delete remote:path
|
|
|
|
That reads "delete everything with a minimum size of 100 MiB", hence
|
|
delete all files bigger than 100 MiB.
|
|
|
|
**Important**: Since this can cause data loss, test first with the
|
|
|--dry-run| or the |--interactive|/|-i| flag.
|
|
`, "|", "`"),
|
|
Annotations: map[string]string{
|
|
"versionIntroduced": "v1.27",
|
|
"groups": "Important,Filter,Listing",
|
|
},
|
|
Run: func(command *cobra.Command, args []string) {
|
|
cmd.CheckArgs(1, 1, command, args)
|
|
fsrc := cmd.NewFsSrc(args)
|
|
cmd.Run(true, false, command, func() error {
|
|
if err := operations.Delete(context.Background(), fsrc); err != nil {
|
|
return err
|
|
}
|
|
if rmdirs {
|
|
fdst := cmd.NewFsDir(args)
|
|
return operations.Rmdirs(context.Background(), fdst, "", true)
|
|
}
|
|
return nil
|
|
})
|
|
},
|
|
}
|