2022-08-28 13:21:57 +02:00
|
|
|
// Package sync provides the sync command.
|
2016-08-05 18:12:27 +02:00
|
|
|
package sync
|
|
|
|
|
|
|
|
import (
|
2019-06-17 10:34:30 +02:00
|
|
|
"context"
|
|
|
|
|
2019-07-28 19:47:38 +02:00
|
|
|
"github.com/rclone/rclone/cmd"
|
2019-10-11 17:55:04 +02:00
|
|
|
"github.com/rclone/rclone/fs/config/flags"
|
2019-07-28 19:47:38 +02:00
|
|
|
"github.com/rclone/rclone/fs/operations"
|
|
|
|
"github.com/rclone/rclone/fs/sync"
|
2016-08-05 18:12:27 +02:00
|
|
|
"github.com/spf13/cobra"
|
|
|
|
)
|
|
|
|
|
2019-03-06 09:43:46 +01:00
|
|
|
var (
|
|
|
|
createEmptySrcDirs = false
|
|
|
|
)
|
|
|
|
|
2016-08-05 18:12:27 +02:00
|
|
|
func init() {
|
2019-10-11 17:58:11 +02:00
|
|
|
cmd.Root.AddCommand(commandDefinition)
|
2019-10-11 17:55:04 +02:00
|
|
|
cmdFlags := commandDefinition.Flags()
|
2023-07-10 19:34:10 +02:00
|
|
|
flags.BoolVarP(cmdFlags, &createEmptySrcDirs, "create-empty-src-dirs", "", createEmptySrcDirs, "Create empty source dirs on destination after sync", "")
|
2016-08-05 18:12:27 +02:00
|
|
|
}
|
|
|
|
|
2019-10-11 17:58:11 +02:00
|
|
|
var commandDefinition = &cobra.Command{
|
2016-08-05 18:12:27 +02:00
|
|
|
Use: "sync source:path dest:path",
|
|
|
|
Short: `Make source and dest identical, modifying destination only.`,
|
|
|
|
Long: `
|
|
|
|
Sync the source to the destination, changing the destination
|
2021-08-19 17:34:57 +02:00
|
|
|
only. Doesn't transfer files that are identical on source and
|
|
|
|
destination, testing by size and modification time or MD5SUM.
|
|
|
|
Destination is updated to match source, including deleting files
|
2022-06-19 15:51:37 +02:00
|
|
|
if necessary (except duplicate objects, see below). If you don't
|
|
|
|
want to delete files from destination, use the
|
|
|
|
[copy](/commands/rclone_copy/) command instead.
|
2016-08-05 18:12:27 +02:00
|
|
|
|
|
|
|
**Important**: Since this can cause data loss, test first with the
|
2020-06-05 18:04:23 +02:00
|
|
|
` + "`--dry-run` or the `--interactive`/`-i`" + ` flag.
|
|
|
|
|
2023-01-20 21:47:36 +01:00
|
|
|
rclone sync --interactive SOURCE remote:DESTINATION
|
2016-08-05 18:12:27 +02:00
|
|
|
|
|
|
|
Note that files in the destination won't be deleted if there were any
|
2020-07-23 11:22:19 +02:00
|
|
|
errors at any point. Duplicate objects (files with the same name, on
|
|
|
|
those providers that support it) are also not yet handled.
|
2016-08-05 18:12:27 +02:00
|
|
|
|
|
|
|
It is always the contents of the directory that is synced, not the
|
2022-06-19 15:43:13 +02:00
|
|
|
directory itself. So when source:path is a directory, it's the contents of
|
2016-08-05 18:12:27 +02:00
|
|
|
source:path that are copied, not the directory name and contents. See
|
2022-06-19 15:51:37 +02:00
|
|
|
extended explanation in the [copy](/commands/rclone_copy/) command if unsure.
|
2016-08-05 18:12:27 +02:00
|
|
|
|
|
|
|
If dest:path doesn't exist, it is created and the source:path contents
|
|
|
|
go there.
|
2018-10-21 11:51:41 +02:00
|
|
|
|
2022-07-11 23:31:30 +02:00
|
|
|
It is not possible to sync overlapping remotes. However, you may exclude
|
|
|
|
the destination from the sync with a filter rule or by putting an
|
|
|
|
exclude-if-present file inside the destination directory and sync to a
|
|
|
|
destination that is inside the source directory.
|
|
|
|
|
2018-10-21 11:51:41 +02:00
|
|
|
**Note**: Use the ` + "`-P`" + `/` + "`--progress`" + ` flag to view real-time transfer statistics
|
2020-07-23 11:22:19 +02:00
|
|
|
|
|
|
|
**Note**: Use the ` + "`rclone dedupe`" + ` command to deal with "Duplicate object/directory found in source/destination - ignoring" errors.
|
|
|
|
See [this forum post](https://forum.rclone.org/t/sync-not-clearing-duplicates/14372) for more info.
|
2016-08-05 18:12:27 +02:00
|
|
|
`,
|
2023-07-10 19:34:10 +02:00
|
|
|
Annotations: map[string]string{
|
|
|
|
"groups": "Sync,Copy,Filter,Listing,Important",
|
|
|
|
},
|
2016-08-05 18:12:27 +02:00
|
|
|
Run: func(command *cobra.Command, args []string) {
|
|
|
|
cmd.CheckArgs(2, 2, command, args)
|
2019-06-23 05:50:09 +02:00
|
|
|
fsrc, srcFileName, fdst := cmd.NewFsSrcFileDst(args)
|
2016-12-04 17:52:24 +01:00
|
|
|
cmd.Run(true, true, command, func() error {
|
2019-06-23 05:50:09 +02:00
|
|
|
if srcFileName == "" {
|
|
|
|
return sync.Sync(context.Background(), fdst, fsrc, createEmptySrcDirs)
|
|
|
|
}
|
|
|
|
return operations.CopyFile(context.Background(), fdst, fsrc, srcFileName, srcFileName)
|
2016-08-05 18:12:27 +02:00
|
|
|
})
|
|
|
|
},
|
|
|
|
}
|