https://rclone.org/commands/ Recent content in Commands on rclone - rsync for cloud storage Hugo -- gohugo.io en https://rclone.org/commands/rclone/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone/ rclone Show help for rclone commands, flags and backends. Synopsis Rclone syncs files to and from cloud storage providers as well as mounting them, listing them in lots of different ways. See the home page (https://rclone.org/) for installation, usage, documentation, changelog and configuration walkthroughs. rclone [flags] Options --alias-description string Description of the remote --alias-remote string Remote or path to alias --ask-password Allow prompt for password for encrypted configuration (default true) --auto-confirm If enabled, do not request console confirmation --azureblob-access-tier string Access tier of blob: hot, cool, cold or archive --azureblob-account string Azure Storage Account Name --azureblob-archive-tier-delete Delete archive tier blobs before overwriting --azureblob-chunk-size SizeSuffix Upload chunk size (default 4Mi) --azureblob-client-certificate-password string Password for the certificate file (optional) (obscured) --azureblob-client-certificate-path string Path to a PEM or PKCS12 certificate file including the private key --azureblob-client-id string The ID of the client in use --azureblob-client-secret string One of the service principal's client secrets --azureblob-client-send-certificate-chain Send the certificate chain when using certificate auth --azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion --azureblob-description string Description of the remote --azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created --azureblob-disable-checksum Don't store MD5 checksum with object metadata --azureblob-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) --azureblob-endpoint string Endpoint for the service --azureblob-env-auth Read credentials from runtime (environment variables, CLI or MSI) --azureblob-key string Storage Account Shared Key --azureblob-list-chunk int Size of blob list (default 5000) --azureblob-msi-client-id string Object ID of the user-assigned MSI to use, if any --azureblob-msi-mi-res-id string Azure resource ID of the user-assigned MSI to use, if any --azureblob-msi-object-id string Object ID of the user-assigned MSI to use, if any --azureblob-no-check-container If set, don't attempt to check the container exists or create it --azureblob-no-head-object If set, do not do HEAD before GET when getting objects --azureblob-password string The user's password (obscured) --azureblob-public-access string Public access level of a container: blob or container --azureblob-sas-url string SAS URL for container level access only --azureblob-service-principal-file string Path to file containing credentials for use with a service principal --azureblob-tenant string ID of the service principal's tenant. https://rclone.org/commands/rclone_about/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_about/ rclone about Get quota information from the remote. Synopsis rclone about prints quota information about a remote to standard output. The output is typically used, free, quota and trash contents. E.g. Typical output from rclone about remote: is: Total: 17 GiB Used: 7.444 GiB Free: 1.315 GiB Trashed: 100.000 MiB Other: 8.241 GiB Where the fields are: Total: Total size available. Used: Total size used. Free: Total space available to this user. https://rclone.org/commands/rclone_authorize/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_authorize/ rclone authorize Remote authorization. Synopsis Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser - use as instructed by rclone config. Use --auth-no-open-browser to prevent rclone to open auth link in default browser automatically. Use --template to generate HTML output via a custom Go template. If a blank string is provided as an argument to this flag, the default template is used. rclone authorize [flags] Options --auth-no-open-browser Do not automatically open auth link in default browser -h, --help help for authorize --template string The path to a custom Go template for generating HTML responses See the global flags page for global options not listed here. https://rclone.org/commands/rclone_backend/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_backend/ rclone backend Run a backend-specific command. Synopsis This runs a backend-specific command. The commands themselves (except for "help" and "features") are defined by the backends and you should see the backend docs for definitions. You can discover what commands a backend implements by using rclone backend help remote: rclone backend help <backendname> You can also discover information about the backend using (see operations/fsinfo in the remote control docs for more info). https://rclone.org/commands/rclone_bisync/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_bisync/ rclone bisync Perform bidirectional synchronization between two paths. Synopsis Perform bidirectional synchronization between two paths. Bisync provides a bidirectional cloud sync solution in rclone. It retains the Path1 and Path2 filesystem listings from the prior run. On each successive run it will: list files on Path1 and Path2, and check for changes on each side. Changes include New, Newer, Older, and Deleted files. Propagate changes on Path1 to Path2, and vice-versa. https://rclone.org/commands/rclone_cat/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_cat/ rclone cat Concatenates any files and sends them to stdout. Synopsis rclone cat sends any files to standard output. You can use it like this to output a single file rclone cat remote:path/to/file Or like this to output any file in dir or its subdirectories. rclone cat remote:path/to/dir Or like this to output any .txt files in dir or its subdirectories. rclone --include "*.txt" cat remote:path/to/dir Use the --head flag to print characters only at the start, --tail for the end and --offset and --count to print a section in the middle. https://rclone.org/commands/rclone_check/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_check/ rclone check Checks the files in the source and destination match. Synopsis Checks the files in the source and destination match. It compares sizes and hashes (MD5 or SHA1) and logs a report of files that don't match. It doesn't alter the source or destination. For the crypt remote there is a dedicated command, cryptcheck, that are able to check the checksums of the encrypted files. If you supply the --size-only flag, it will only compare the sizes not the hashes as well. https://rclone.org/commands/rclone_checksum/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_checksum/ rclone checksum Checks the files in the destination against a SUM file. Synopsis Checks that hashsums of destination files match the SUM file. It compares hashes (MD5, SHA1, etc) and logs a report of files which don't match. It doesn't alter the file system. The sumfile is treated as the source and the dst:path is treated as the destination for the purposes of the output. If you supply the --download flag, it will download the data from the remote and calculate the content hash on the fly. https://rclone.org/commands/rclone_cleanup/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_cleanup/ rclone cleanup Clean up the remote if possible. Synopsis Clean up the remote if possible. Empty the trash or delete old file versions. Not supported by all remotes. rclone cleanup remote:path [flags] Options -h, --help help for cleanup Important Options Important flags useful for most commands. -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) See the global flags page for global options not listed here. https://rclone.org/commands/rclone_completion/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_completion/ rclone completion Output completion script for a given shell. Synopsis Generates a shell completion script for rclone. Run with --help to list the supported shells. Options -h, --help help for completion See the global flags page for global options not listed here. SEE ALSO rclone - Show help for rclone commands, flags and backends. rclone completion bash - Output bash completion script for rclone. rclone completion fish - Output fish completion script for rclone. https://rclone.org/commands/rclone_completion_bash/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_completion_bash/ rclone completion bash Output bash completion script for rclone. Synopsis Generates a bash shell autocompletion script for rclone. This writes to /etc/bash_completion.d/rclone by default so will probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete bash Logout and login again to use the autocompletion scripts, or source them directly . /etc/bash_completion If you supply a command line argument the script will be written there. If output_file is "-", then the output will be written to stdout. https://rclone.org/commands/rclone_completion_fish/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_completion_fish/ rclone completion fish Output fish completion script for rclone. Synopsis Generates a fish autocompletion script for rclone. This writes to /etc/fish/completions/rclone.fish by default so will probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete fish Logout and login again to use the autocompletion scripts, or source them directly . /etc/fish/completions/rclone.fish If you supply a command line argument the script will be written there. If output_file is "-", then the output will be written to stdout. https://rclone.org/commands/rclone_completion_powershell/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_completion_powershell/ rclone completion powershell Output powershell completion script for rclone. Synopsis Generate the autocompletion script for powershell. To load completions in your current shell session: rclone completion powershell | Out-String | Invoke-Expression To load completions for every new session, add the output of the above command to your powershell profile. If output_file is "-" or missing, then the output will be written to stdout. rclone completion powershell [output_file] [flags] Options -h, --help help for powershell See the global flags page for global options not listed here. https://rclone.org/commands/rclone_completion_zsh/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_completion_zsh/ rclone completion zsh Output zsh completion script for rclone. Synopsis Generates a zsh autocompletion script for rclone. This writes to /usr/share/zsh/vendor-completions/_rclone by default so will probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete zsh Logout and login again to use the autocompletion scripts, or source them directly autoload -U compinit && compinit If you supply a command line argument the script will be written there. https://rclone.org/commands/rclone_config/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config/ rclone config Enter an interactive configuration session. Synopsis Enter an interactive configuration session where you can setup new remotes and manage existing ones. You may also set or remove a password to protect your configuration. rclone config [flags] Options -h, --help help for config See the global flags page for global options not listed here. SEE ALSO rclone - Show help for rclone commands, flags and backends. rclone config create - Create a new remote with name, type and options. https://rclone.org/commands/rclone_config_create/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_create/ rclone config create Create a new remote with name, type and options. Synopsis Create a new remote of name with type and options. The options should be passed in pairs of key value or as key=value. For example, to make a swift remote of name myremote using auto config you would do: rclone config create myremote swift env_auth true rclone config create myremote swift env_auth=true So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this: https://rclone.org/commands/rclone_config_delete/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_delete/ rclone config delete Delete an existing remote. rclone config delete name [flags] Options -h, --help help for delete See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_config_disconnect/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_disconnect/ rclone config disconnect Disconnects user from remote Synopsis This disconnects the remote: passed in to the cloud storage system. This normally means revoking the oauth token. To reconnect use "rclone config reconnect". rclone config disconnect remote: [flags] Options -h, --help help for disconnect See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_config_dump/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_dump/ rclone config dump Dump the config file as JSON. rclone config dump [flags] Options -h, --help help for dump See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_config_edit/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_edit/ rclone config edit Enter an interactive configuration session. Synopsis Enter an interactive configuration session where you can setup new remotes and manage existing ones. You may also set or remove a password to protect your configuration. rclone config edit [flags] Options -h, --help help for edit See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_config_file/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_file/ rclone config file Show path of configuration file in use. rclone config file [flags] Options -h, --help help for file See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_config_password/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_password/ rclone config password Update password in an existing remote. Synopsis Update an existing remote's password. The password should be passed in pairs of key password or as key=password. The password should be passed in in clear (unobscured). For example, to set password of a remote of name myremote you would do: rclone config password myremote fieldname mypassword rclone config password myremote fieldname=mypassword This command is obsolete now that "config update" and "config create" both support obscuring passwords directly. https://rclone.org/commands/rclone_config_paths/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_paths/ rclone config paths Show paths used for configuration, cache, temp etc. rclone config paths [flags] Options -h, --help help for paths See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_config_providers/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_providers/ rclone config providers List in JSON format all the providers and options. rclone config providers [flags] Options -h, --help help for providers See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_config_reconnect/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_reconnect/ rclone config reconnect Re-authenticates user with remote. Synopsis This reconnects remote: passed in to the cloud storage system. To disconnect the remote use "rclone config disconnect". This normally means going through the interactive oauth flow again. rclone config reconnect remote: [flags] Options -h, --help help for reconnect See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_config_redacted/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_redacted/ rclone config redacted Print redacted (decrypted) config file, or the redacted config for a single remote. Synopsis This prints a redacted copy of the config file, either the whole config file or for a given remote. The config file will be redacted by replacing all passwords and other sensitive info with XXX. This makes the config file suitable for posting online for support. It should be double checked before posting as the redaction may not be perfect. https://rclone.org/commands/rclone_config_show/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_show/ rclone config show Print (decrypted) config file, or the config for a single remote. rclone config show [<remote>] [flags] Options -h, --help help for show See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_config_touch/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_touch/ rclone config touch Ensure configuration file exists. rclone config touch [flags] Options -h, --help help for touch See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_config_update/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_update/ rclone config update Update options in an existing remote. Synopsis Update an existing remote's options. The options should be passed in pairs of key value or as key=value. For example, to update the env_auth field of a remote of name myremote you would do: rclone config update myremote env_auth true rclone config update myremote env_auth=true If the remote uses OAuth the token will be updated, if you don't require this add an extra parameter thus: https://rclone.org/commands/rclone_config_userinfo/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_config_userinfo/ rclone config userinfo Prints info about logged in user of remote. Synopsis This prints the details of the person logged in to the cloud storage system. rclone config userinfo remote: [flags] Options -h, --help help for userinfo --json Format output as JSON See the global flags page for global options not listed here. SEE ALSO rclone config - Enter an interactive configuration session. https://rclone.org/commands/rclone_copy/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_copy/ rclone copy Copy files from source to dest, skipping identical files. Synopsis Copy the source to the destination. Does not transfer files that are identical on source and destination, testing by size and modification time or MD5SUM. Doesn't delete files from the destination. If you want to also delete files from destination, to make it match source, use the sync command instead. Note that it is always the contents of the directory that is synced, not the directory itself. https://rclone.org/commands/rclone_copyto/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_copyto/ rclone copyto Copy files from source to dest, skipping identical files. Synopsis If source:path is a file or directory then it copies it to a file or directory named dest:path. This can be used to upload single files to other than their current name. If the source is a directory then it acts exactly like the copy command. So rclone copyto src dst where src and dst are rclone paths, either remote:path or /path/to/local or C:\windows\path\if\on\windows. https://rclone.org/commands/rclone_copyurl/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_copyurl/ rclone copyurl Copy the contents of the URL supplied content to dest:path. Synopsis Download a URL's content and copy it to the destination without saving it in temporary storage. Setting --auto-filename will attempt to automatically determine the filename from the URL (after any redirections) and used in the destination path. With --auto-filename-header in addition, if a specific filename is set in HTTP headers, it will be used instead of the name from the URL. https://rclone.org/commands/rclone_cryptcheck/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_cryptcheck/ rclone cryptcheck Cryptcheck checks the integrity of an encrypted remote. Synopsis rclone cryptcheck checks a remote against a crypted remote. This is the equivalent of running rclone check, but able to check the checksums of the encrypted remote. For it to work the underlying remote of the cryptedremote must support some kind of checksum. It works by reading the nonce from each file on the cryptedremote: and using that to encrypt each file on the remote:. https://rclone.org/commands/rclone_cryptdecode/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_cryptdecode/ rclone cryptdecode Cryptdecode returns unencrypted file names. Synopsis rclone cryptdecode returns unencrypted file names when provided with a list of encrypted file names. List limit is 10 items. If you supply the --reverse flag, it will return encrypted file names. use it like this rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2 rclone cryptdecode --reverse encryptedremote: filename1 filename2 Another way to accomplish this is by using the rclone backend encode (or decode) command. See the documentation on the crypt overlay for more info. https://rclone.org/commands/rclone_dedupe/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_dedupe/ rclone dedupe Interactively find duplicate filenames and delete/rename them. Synopsis By default dedupe interactively finds files with duplicate names and offers to delete all but one or rename them to be different. This is known as deduping by name. Deduping by name is only useful with a small group of backends (e.g. Google Drive, Opendrive) that can have duplicate file names. It can be run on wrapping backends (e.g. crypt) if they wrap a backend which supports duplicate file names. https://rclone.org/commands/rclone_delete/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_delete/ rclone delete Remove the files in path. Synopsis Remove the files in path. Unlike 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 command. If you supply the --rmdirs flag, it will remove all empty directories along with it. You can also use the separate command rmdir or rmdirs to delete empty directories only. https://rclone.org/commands/rclone_deletefile/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_deletefile/ rclone deletefile Remove a single file from remote. Synopsis Remove a single file from remote. Unlike delete it cannot be used to remove a directory and it doesn't obey include/exclude filters - if the specified file exists, it will always be removed. rclone deletefile remote:path [flags] Options -h, --help help for deletefile Important Options Important flags useful for most commands. -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) See the global flags page for global options not listed here. https://rclone.org/commands/rclone_genautocomplete/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_genautocomplete/ rclone genautocomplete Output completion script for a given shell. Synopsis Generates a shell completion script for rclone. Run with --help to list the supported shells. Options -h, --help help for genautocomplete See the global flags page for global options not listed here. SEE ALSO rclone - Show help for rclone commands, flags and backends. rclone genautocomplete bash - Output bash completion script for rclone. rclone genautocomplete fish - Output fish completion script for rclone. https://rclone.org/commands/rclone_genautocomplete_bash/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_genautocomplete_bash/ rclone genautocomplete bash Output bash completion script for rclone. Synopsis Generates a bash shell autocompletion script for rclone. This writes to /etc/bash_completion.d/rclone by default so will probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete bash Logout and login again to use the autocompletion scripts, or source them directly . /etc/bash_completion If you supply a command line argument the script will be written there. If output_file is "-", then the output will be written to stdout. https://rclone.org/commands/rclone_genautocomplete_fish/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_genautocomplete_fish/ rclone genautocomplete fish Output fish completion script for rclone. Synopsis Generates a fish autocompletion script for rclone. This writes to /etc/fish/completions/rclone.fish by default so will probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete fish Logout and login again to use the autocompletion scripts, or source them directly . /etc/fish/completions/rclone.fish If you supply a command line argument the script will be written there. If output_file is "-", then the output will be written to stdout. https://rclone.org/commands/rclone_genautocomplete_zsh/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_genautocomplete_zsh/ rclone genautocomplete zsh Output zsh completion script for rclone. Synopsis Generates a zsh autocompletion script for rclone. This writes to /usr/share/zsh/vendor-completions/_rclone by default so will probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete zsh Logout and login again to use the autocompletion scripts, or source them directly autoload -U compinit && compinit If you supply a command line argument the script will be written there. https://rclone.org/commands/rclone_gendocs/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_gendocs/ rclone gendocs Output markdown docs for rclone to the directory supplied. Synopsis This produces markdown docs for the rclone commands to the directory supplied. These are in a format suitable for hugo to render into the rclone.org website. rclone gendocs output_directory [flags] Options -h, --help help for gendocs See the global flags page for global options not listed here. SEE ALSO rclone - Show help for rclone commands, flags and backends. https://rclone.org/commands/rclone_hashsum/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_hashsum/ rclone hashsum Produces a hashsum file for all the objects in the path. Synopsis Produces a hash file for all the objects in the path using the hash named. The output is in the same format as the standard md5sum/sha1sum tool. By default, the hash is requested from the remote. If the hash is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling any hash for any remote. https://rclone.org/commands/rclone_link/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_link/ rclone link Generate public link to file/folder. Synopsis rclone link will create, retrieve or remove a public link to the given file or folder. rclone link remote:path/to/file rclone link remote:path/to/folder/ rclone link --unlink remote:path/to/folder/ rclone link --expire 1d remote:path/to/file If you supply the --expire flag, it will set the expiration time otherwise it will use the default (100 years). Note not all backends support the --expire flag - if the backend doesn't support it then the link returned won't expire. https://rclone.org/commands/rclone_listremotes/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_listremotes/ rclone listremotes List all the remotes in the config file and defined in environment variables. Synopsis rclone listremotes lists all the available remotes from the config file. When used with the --long flag it lists the types and the descriptions too. rclone listremotes [flags] Options -h, --help help for listremotes --long Show the type and the description as well as names See the global flags page for global options not listed here. https://rclone.org/commands/rclone_ls/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_ls/ rclone ls List the objects in the path with size and path. Synopsis 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 Any of the filtering options can be applied to this command. There are several related list commands ls to list size and path of objects only lsl to list modification time, size and path of objects only lsd to list directories only lsf to list objects and directories in easy to parse format lsjson to list objects and directories in JSON format ls,lsl,lsd are designed to be human-readable. https://rclone.org/commands/rclone_lsd/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_lsd/ rclone lsd List all directories/containers/buckets in the path. Synopsis 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 https://rclone.org/commands/rclone_lsf/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_lsf/ rclone lsf List directories and objects in remote:path formatted for parsing. Synopsis List the contents of the source path (directories and objects) to standard output in a form which is easy to parse by scripts. By default this will just be the names of the objects and directories, one per line. The directories will have a / suffix. Eg $ rclone lsf swift:bucket bevajer5jef canole diwogej7 ferejej3gux/ fubuwic Use the --format option to control what gets listed. https://rclone.org/commands/rclone_lsjson/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_lsjson/ rclone lsjson List directories and objects in the path in JSON format. Synopsis List directories and objects in the path in JSON format. The output is an array of Items, where each Item looks like this { "Hashes" : { "SHA-1" : "f572d396fae9206628714fb2ce00f72e94f2258f", "MD5" : "b1946ac92492d2347c6235b4d2611184", "DropboxHash" : "ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc" }, "ID": "y2djkhiujf83u33", "OrigID": "UYOJVTUW00Q1RzTDA", "IsBucket" : false, "IsDir" : false, "MimeType" : "application/octet-stream", "ModTime" : "2017-05-31T16:15:57.034468261+01:00", "Name" : "file.txt", "Encrypted" : "v0qpsdq8anpci8n929v3uu9338", "EncryptedPath" : "kja9098349023498/v0qpsdq8anpci8n929v3uu9338", "Path" : "full/path/goes/here/file. https://rclone.org/commands/rclone_lsl/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_lsl/ rclone lsl List the objects in path with modification time, size and path. Synopsis Lists the objects in the source path to standard output in a human readable format with modification time, size and path. Recurses by default. Eg $ rclone lsl swift:bucket 60295 2016-06-25 18:55:41.062626927 bevajer5jef 90613 2016-06-25 18:55:43.302607074 canole 94467 2016-06-25 18:55:43.046609333 diwogej7 37600 2016-06-25 18:55:40.814629136 fubuwic Any of the filtering options can be applied to this command. https://rclone.org/commands/rclone_md5sum/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_md5sum/ rclone md5sum Produces an md5sum file for all the objects in the path. Synopsis Produces an md5sum file for all the objects in the path. This is in the same format as the standard md5sum tool produces. By default, the hash is requested from the remote. If MD5 is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling MD5 for any remote. https://rclone.org/commands/rclone_mkdir/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_mkdir/ rclone mkdir Make the path if it doesn't already exist. rclone mkdir remote:path [flags] Options -h, --help help for mkdir Important Options Important flags useful for most commands. -n, --dry-run Do a trial run with no permanent changes -i, --interactive Enable interactive mode -v, --verbose count Print lots more stuff (repeat for more) See the global flags page for global options not listed here. SEE ALSO rclone - Show help for rclone commands, flags and backends. https://rclone.org/commands/rclone_mount/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_mount/ rclone mount Mount the remote as file system on a mountpoint. Synopsis rclone mount allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE. First set up your remote using rclone config. Check it works with rclone ls etc. On Linux and macOS, you can run mount in either foreground or background (aka daemon) mode. Mount runs in foreground mode by default. https://rclone.org/commands/rclone_move/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_move/ rclone move Move files from source to dest. Synopsis Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and the remote does not support a server-side directory move operation. To move single files, use the moveto command instead. If no filters are in use and if possible this will server-side move source:path into dest:path. After this source:path will no longer exist. https://rclone.org/commands/rclone_moveto/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_moveto/ rclone moveto Move file or directory from source to dest. Synopsis If source:path is a file or directory then it moves it to a file or directory named dest:path. This can be used to rename files or upload single files to other than their existing name. If the source is a directory then it acts exactly like the move command. So rclone moveto src dst where src and dst are rclone paths, either remote:path or /path/to/local or C:\windows\path\if\on\windows. https://rclone.org/commands/rclone_ncdu/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_ncdu/ rclone ncdu Explore a remote with a text based user interface. Synopsis This displays a text based user interface allowing the navigation of a remote. It is most useful for answering the question - "What is using all my disk space?". To make the user interface it first scans the entire remote given and builds an in memory representation. rclone ncdu can be used during this scanning phase and you will see it building up the directory structure as it goes along. https://rclone.org/commands/rclone_nfsmount/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_nfsmount/ rclone nfsmount Mount the remote as file system on a mountpoint. Synopsis rclone nfsmount allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE. First set up your remote using rclone config. Check it works with rclone ls etc. On Linux and macOS, you can run mount in either foreground or background (aka daemon) mode. Mount runs in foreground mode by default. https://rclone.org/commands/rclone_obscure/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_obscure/ rclone obscure Obscure password for use in the rclone config file. Synopsis In the rclone config file, human-readable passwords are obscured. Obscuring them is done by encrypting them and writing them out in base64. This is not a secure way of encrypting these passwords as rclone can decrypt them - it is to prevent "eyedropping" namely someone seeing a password in the rclone config file by accident. Many equally important things (like access tokens) are not obscured in the config file. https://rclone.org/commands/rclone_purge/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_purge/ rclone purge Remove the path and all of its contents. Synopsis Remove the path and all of its contents. Note that this does not obey include/exclude filters - everything will be removed. Use the delete command if you want to selectively delete files. To delete empty directories only, use command rmdir or rmdirs. Important: Since this can cause data loss, test first with the --dry-run or the --interactive/-i flag. rclone purge remote:path [flags] Options -h, --help help for purge Important Options Important flags useful for most commands. https://rclone.org/commands/rclone_rc/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_rc/ rclone rc Run a command against a running rclone. Synopsis This runs a command against a running rclone. Use the --url flag to specify an non default URL to connect on. This can be either a ":port" which is taken to mean "http://localhost:port" or a "host:port" which is taken to mean "http://host:port" A username and password can be passed in with --user and --pass. Note that --rc-addr, --rc-user, --rc-pass will be read also for --url, --user, --pass. https://rclone.org/commands/rclone_rcat/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_rcat/ rclone rcat Copies standard input to file on remote. Synopsis rclone rcat reads from standard input (stdin) and copies it to a single remote file. echo "hello world" | rclone rcat remote:path/to/file ffmpeg - | rclone rcat remote:path/to/file If the remote file already exists, it will be overwritten. rcat will try to upload small files in a single request, which is usually more efficient than the streaming/chunked upload endpoints, which use multiple requests. https://rclone.org/commands/rclone_rcd/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_rcd/ rclone rcd Run rclone listening to remote control commands only. Synopsis This runs rclone so that it only listens to remote control commands. This is useful if you are controlling rclone via the rc API. If you pass in a path to a directory, rclone will serve that directory for GET requests on the URL passed in. It will also open the URL in the browser when rclone is run. https://rclone.org/commands/rclone_rmdir/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_rmdir/ rclone rmdir Remove the empty directory at path. Synopsis This removes empty directory given by path. Will not remove the path if it has any objects in it, not even empty subdirectories. Use command rmdirs (or delete with option --rmdirs) to do that. To delete a path and any objects in it, use purge command. rclone rmdir remote:path [flags] Options -h, --help help for rmdir Important Options Important flags useful for most commands. https://rclone.org/commands/rclone_rmdirs/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_rmdirs/ rclone rmdirs Remove empty directories under the path. Synopsis This recursively removes any empty directories (including directories that only contain empty directories), that it finds under the path. The root path itself will also be removed if it is empty, unless you supply the --leave-root flag. Use command rmdir to delete just the empty directory given by path, not recurse. This is useful for tidying up remotes that rclone has left a lot of empty directories in. https://rclone.org/commands/rclone_selfupdate/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_selfupdate/ rclone selfupdate Update the rclone binary. Synopsis This command downloads the latest release of rclone and replaces the currently running binary. The download is verified with a hashsum and cryptographically signed signature; see the release signing docs for details. If used without flags (or with implied --stable flag), this command will install the latest stable release. However, some issues may be fixed (or features added) only in the latest beta release. https://rclone.org/commands/rclone_serve/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_serve/ rclone serve Serve a remote over a protocol. Synopsis Serve a remote over a given protocol. Requires the use of a subcommand to specify the protocol, e.g. rclone serve http remote: Each subcommand has its own options which you can see in their help. rclone serve <protocol> [opts] <remote> [flags] Options -h, --help help for serve See the global flags page for global options not listed here. SEE ALSO rclone - Show help for rclone commands, flags and backends. https://rclone.org/commands/rclone_serve_dlna/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_serve_dlna/ rclone serve dlna Serve remote:path over DLNA Synopsis Run a DLNA media server for media stored in an rclone remote. Many devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN and play audio/video from it. VLC is also supported. Service discovery uses UDP multicast packets (SSDP) and will thus only work on LANs. Rclone will list all files present in the remote, without filtering based on media formats or file extensions. https://rclone.org/commands/rclone_serve_docker/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_serve_docker/ rclone serve docker Serve any remote on docker's volume plugin API. Synopsis This command implements the Docker volume plugin API allowing docker to use rclone as a data storage mechanism for various cloud providers. rclone provides docker volume plugin based on it. To create a docker plugin, one must create a Unix or TCP socket that Docker will look for when you use the plugin and then it listens for commands from docker daemon and runs the corresponding code when necessary. https://rclone.org/commands/rclone_serve_ftp/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_serve_ftp/ rclone serve ftp Serve remote:path over FTP. Synopsis Run a basic FTP server to serve a remote over FTP protocol. This can be viewed with a FTP client or you can make a remote of type FTP to read and write it. Server options Use --addr to specify which IP address and port the server should listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. https://rclone.org/commands/rclone_serve_http/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_serve_http/ rclone serve http Serve the remote over HTTP. Synopsis Run a basic web server to serve a remote over HTTP. This can be viewed in a web browser or you can make a remote of type http read from it. You can use the filter flags (e.g. --include, --exclude) to control what is served. The server will log errors. Use -v to see access logs. --bwlimit will be respected for file transfers. https://rclone.org/commands/rclone_serve_nfs/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_serve_nfs/ rclone serve nfs Serve the remote as an NFS mount Synopsis Create an NFS server that serves the given remote over the network. The primary purpose for this command is to enable mount command on recent macOS versions where installing FUSE is very cumbersome. Since this is running on NFSv3, no authentication method is available. Any client will be able to access the data. To limit access, you can use serve NFS on loopback address and rely on secure tunnels (such as SSH). https://rclone.org/commands/rclone_serve_restic/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_serve_restic/ rclone serve restic Serve the remote for restic's REST API. Synopsis Run a basic web server to serve a remote over restic's REST backend API over HTTP. This allows restic to use rclone as a data storage mechanism for cloud providers that restic does not support directly. Restic is a command-line program for doing backups. The server will log errors. Use -v to see access logs. --bwlimit will be respected for file transfers. https://rclone.org/commands/rclone_serve_s3/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_serve_s3/ rclone serve s3 Serve remote:path over s3. Synopsis serve s3 implements a basic s3 server that serves a remote via s3. This can be viewed with an s3 client, or you can make an s3 type remote to read and write to it with rclone. serve s3 is considered Experimental so use with care. S3 server supports Signature Version 4 authentication. Just use --auth-key accessKey,secretKey and set the Authorization header correctly in the request. https://rclone.org/commands/rclone_serve_sftp/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_serve_sftp/ rclone serve sftp Serve the remote over SFTP. Synopsis Run an SFTP server to serve a remote over SFTP. This can be used with an SFTP client or you can make a remote of type sftp to use with it. You can use the filter flags (e.g. --include, --exclude) to control what is served. The server will respond to a small number of shell commands, mainly md5sum, sha1sum and df, which enable it to provide support for checksums and the about feature when accessed from an sftp remote. https://rclone.org/commands/rclone_serve_webdav/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_serve_webdav/ rclone serve webdav Serve remote:path over WebDAV. Synopsis Run a basic WebDAV server to serve a remote over HTTP via the WebDAV protocol. This can be viewed with a WebDAV client, through a web browser, or you can make a remote of type WebDAV to read and write it. WebDAV options --etag-hash This controls the ETag header. Without this flag the ETag will be based on the ModTime and Size of the object. https://rclone.org/commands/rclone_settier/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_settier/ rclone settier Changes storage class/tier of objects in remote. Synopsis rclone settier changes storage tier or class at remote if supported. Few cloud storage services provides different storage classes on objects, for example AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive, Google Cloud Storage, Regional Storage, Nearline, Coldline etc. Note that, certain tier changes make objects not available to access immediately. For example tiering to archive in azure blob storage makes objects in frozen state, user can restore by setting tier to Hot/Cool, similarly S3 to Glacier makes object inaccessible. https://rclone.org/commands/rclone_sha1sum/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_sha1sum/ rclone sha1sum Produces an sha1sum file for all the objects in the path. Synopsis Produces an sha1sum file for all the objects in the path. This is in the same format as the standard sha1sum tool produces. By default, the hash is requested from the remote. If SHA-1 is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling SHA-1 for any remote. https://rclone.org/commands/rclone_size/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_size/ rclone size Prints the total size and number of objects in remote:path. Synopsis Counts objects in the path and calculates the total size. Prints the result to standard output. By default the output is in human-readable format, but shows values in both human-readable format as well as the raw numbers (global option --human-readable is not considered). Use option --json to format output as JSON instead. Recurses by default, use --max-depth 1 to stop the recursion. https://rclone.org/commands/rclone_sync/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_sync/ rclone sync Make source and dest identical, modifying destination only. Synopsis Sync the source to the destination, changing the destination 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 if necessary (except duplicate objects, see below). If you don't want to delete files from destination, use the copy command instead. Important: Since this can cause data loss, test first with the --dry-run or the --interactive/-i flag. https://rclone.org/commands/rclone_test/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_test/ rclone test Run a test command Synopsis Rclone test is used to run test commands. Select which test command you want with the subcommand, eg rclone test memory remote: Each subcommand has its own options which you can see in their help. NB Be careful running these commands, they may do strange things so reading their documentation first is recommended. Options -h, --help help for test See the global flags page for global options not listed here. https://rclone.org/commands/rclone_test_changenotify/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_test_changenotify/ rclone test changenotify Log any change notify requests for the remote passed in. rclone test changenotify remote: [flags] Options -h, --help help for changenotify --poll-interval Duration Time to wait between polling for changes (default 10s) See the global flags page for global options not listed here. SEE ALSO rclone test - Run a test command https://rclone.org/commands/rclone_test_histogram/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_test_histogram/ rclone test histogram Makes a histogram of file name characters. Synopsis This command outputs JSON which shows the histogram of characters used in filenames in the remote:path specified. The data doesn't contain any identifying information but is useful for the rclone developers when developing filename compression. rclone test histogram [remote:path] [flags] Options -h, --help help for histogram See the global flags page for global options not listed here. SEE ALSO rclone test - Run a test command https://rclone.org/commands/rclone_test_info/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_test_info/ rclone test info Discovers file name or other limitations for paths. Synopsis rclone info discovers what filenames and upload methods are possible to write to the paths passed in and how long they can be. It can take some time. It will write test files into the remote:path passed in. It outputs a bit of go code for each one. NB this can create undeletable files and other hazards - use with care https://rclone.org/commands/rclone_test_makefile/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_test_makefile/ rclone test makefile Make files with random contents of the size given rclone test makefile <size> [<file>]+ [flags] Options --ascii Fill files with random ASCII printable bytes only --chargen Fill files with a ASCII chargen pattern -h, --help help for makefile --pattern Fill files with a periodic pattern --seed int Seed for the random number generator (0 for random) (default 1) --sparse Make the files sparse (appear to be filled with ASCII 0x00) --zero Fill files with ASCII 0x00 See the global flags page for global options not listed here. https://rclone.org/commands/rclone_test_makefiles/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_test_makefiles/ rclone test makefiles Make a random file hierarchy in a directory rclone test makefiles <dir> [flags] Options --ascii Fill files with random ASCII printable bytes only --chargen Fill files with a ASCII chargen pattern --files int Number of files to create (default 1000) --files-per-directory int Average number of files per directory (default 10) -h, --help help for makefiles --max-depth int Maximum depth of directory hierarchy (default 10) --max-file-size SizeSuffix Maximum size of files to create (default 100) --max-name-length int Maximum size of file names (default 12) --min-file-size SizeSuffix Minimum size of file to create --min-name-length int Minimum size of file names (default 4) --pattern Fill files with a periodic pattern --seed int Seed for the random number generator (0 for random) (default 1) --sparse Make the files sparse (appear to be filled with ASCII 0x00) --zero Fill files with ASCII 0x00 See the global flags page for global options not listed here. https://rclone.org/commands/rclone_test_memory/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_test_memory/ rclone test memory Load all the objects at remote:path into memory and report memory stats. rclone test memory remote:path [flags] Options -h, --help help for memory See the global flags page for global options not listed here. SEE ALSO rclone test - Run a test command https://rclone.org/commands/rclone_touch/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_touch/ rclone touch Create new file or change file modification time. Synopsis Set the modification time on file(s) as specified by remote:path to have the current time. If remote:path does not exist then a zero sized file will be created, unless --no-create or --recursive is provided. If --recursive is used then recursively sets the modification time on all existing files that is found under the path. Filters are supported, and you can test with the --dry-run or the --interactive/-i flag. https://rclone.org/commands/rclone_tree/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_tree/ rclone tree List the contents of the remote in a tree like fashion. Synopsis rclone tree lists the contents of a remote in a similar way to the unix tree command. For example $ rclone tree remote:path / ├── file1 ├── file2 ├── file3 └── subdir ├── file4 └── file5 1 directories, 5 files You can use any of the filtering options with the tree command (e.g. --include and --exclude. You can also use --fast-list. https://rclone.org/commands/rclone_version/ Mon, 01 Jan 0001 00:00:00 +0000 https://rclone.org/commands/rclone_version/ rclone version Show the version number. Synopsis Show the rclone version number, the go version, the build target OS and architecture, the runtime OS and kernel version and bitness, build tags and the type of executable (static or dynamic). For example: $ rclone version rclone v1.55.0 - os/version: ubuntu 18.04 (64 bit) - os/kernel: 4.15.0-136-generic (x86_64) - os/type: linux - os/arch: amd64 - go/version: go1.16 - go/linking: static - go/tags: none Note: before rclone version 1.