f-denkena/rclone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Version v1.57.0

Browse Source
This commit is contained in:
Nick Craig-Wood
2021-11-01 15:45:40 +00:00
parent e781bcbba1
commit 169990e270
96 changed files with 19756 additions and 11228 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/rc.md
+124 -101
View File
@@ -431,18 +431,18 @@ And this is equivalent to `/tmp/dir`
{{< rem autogenerated start "- run make rcdocs - don't edit here" >}}
### backend/command: Runs a backend command. {#backend-command}
This takes the following parameters
This takes the following parameters:
- command - a string with the command name
- fs - a remote name string e.g. "drive:"
- arg - a list of arguments for the backend command
- opt - a map of string to string of options
Returns
Returns:
- result - result from the backend command
For example
Example:
rclone rc backend/command command=noop fs=. -o echo=yes -o blue -a path1 -a path2
@@ -520,7 +520,7 @@ Show statistics for the cache remote.
### config/create: create the config for a remote. {#config-create}
This takes the following parameters
This takes the following parameters:
- name - name of remote
- parameters - a map of \{ "key": "value" \} pairs
@@ -581,7 +581,7 @@ See the [listremotes command](/commands/rclone_listremotes/) command for more in
### config/password: password the config for a remote. {#config-password}
This takes the following parameters
This takes the following parameters:
- name - name of remote
- parameters - a map of \{ "key": "value" \} pairs
@@ -602,7 +602,7 @@ See the [config providers command](/commands/rclone_config_providers/) command f
### config/update: update the config for a remote. {#config-update}
This takes the following parameters
This takes the following parameters:
- name - name of remote
- parameters - a map of \{ "key": "value" \} pairs
@@ -668,29 +668,29 @@ In either case "rate" is returned as a human readable string, and
### core/command: Run a rclone terminal command over rc. {#core-command}
This takes the following parameters
This takes the following parameters:
- command - a string with the command name
- arg - a list of arguments for the backend command
- opt - a map of string to string of options
- returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR")
- defaults to "COMBINED_OUTPUT" if not set
- the STREAM returnTypes will write the output to the body of the HTTP message
- the COMBINED_OUTPUT will write the output to the "result" parameter
- command - a string with the command name.
- arg - a list of arguments for the backend command.
- opt - a map of string to string of options.
- returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR").
- Defaults to "COMBINED_OUTPUT" if not set.
- The STREAM returnTypes will write the output to the body of the HTTP message.
- The COMBINED_OUTPUT will write the output to the "result" parameter.
Returns
Returns:
- result - result from the backend command
- only set when using returnType "COMBINED_OUTPUT"
- error - set if rclone exits with an error code
- returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR")
- result - result from the backend command.
- Only set when using returnType "COMBINED_OUTPUT".
- error - set if rclone exits with an error code.
- returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR").
For example
Example:
rclone rc core/command command=ls -a mydrive:/ -o max-depth=1
rclone rc core/command -a ls -a mydrive:/ -o max-depth=1
Returns
Returns:
```
{
@@ -737,17 +737,17 @@ are explained in the go docs: https://golang.org/pkg/runtime/#MemStats
The most interesting values for most people are:
* HeapAlloc: This is the amount of memory rclone is actually using
* HeapSys: This is the amount of memory rclone has obtained from the OS
* Sys: this is the total amount of memory requested from the OS
* It is virtual memory so may include unused memory
- HeapAlloc - this is the amount of memory rclone is actually using
- HeapSys - this is the amount of memory rclone has obtained from the OS
- Sys - this is the total amount of memory requested from the OS
- It is virtual memory so may include unused memory
### core/obscure: Obscures a string passed in. {#core-obscure}
Pass a clear string and rclone will obscure it for the config file:
- clear - string
Returns
Returns:
- obscured - string
### core/pid: Return PID of current process {#core-pid}
@@ -757,7 +757,7 @@ Useful for stopping rclone process.
### core/quit: Terminates the app. {#core-quit}
(optional) Pass an exit code to be used for terminating the app:
(Optional) Pass an exit code to be used for terminating the app:
- exitCode - int
### core/stats: Returns stats about current transfers. {#core-stats}
@@ -814,7 +814,7 @@ The value for "eta" is null if an eta cannot be determined.
### core/stats-delete: Delete stats group. {#core-stats-delete}
This deletes entire stats group
This deletes entire stats group.
Parameters
@@ -864,7 +864,7 @@ Returns the following values:
### core/version: Shows the current version of rclone and the go runtime. {#core-version}
This shows the current version of go and the go runtime
This shows the current version of go and the go runtime:
- version - rclone version, e.g. "v1.53.0"
- decomposed - version number as [major, minor, patch]
@@ -889,7 +889,7 @@ After calling this you can use this to see the blocking profile:
go tool pprof http://localhost:5572/debug/pprof/block
Parameters
Parameters:
- rate - int
@@ -906,11 +906,11 @@ Once this is set you can look use this to profile the mutex contention:
go tool pprof http://localhost:5572/debug/pprof/mutex
Parameters
Parameters:
- rate - int
Results
Results:
- previousRate - int
@@ -936,19 +936,19 @@ Returns
### job/list: Lists the IDs of the running jobs {#job-list}
Parameters - None
Parameters: None.
Results
Results:
- jobids - array of integer job ids
- jobids - array of integer job ids.
### job/status: Reads the status of the job ID {#job-status}
Parameters
Parameters:
- jobid - id of the job (integer)
- jobid - id of the job (integer).
Results
Results:
- finished - boolean
- duration - time in seconds that the job ran for
@@ -963,13 +963,13 @@ Results
### job/stop: Stop the running job {#job-stop}
Parameters
Parameters:
- jobid - id of the job (integer)
- jobid - id of the job (integer).
### mount/listmounts: Show current mount points {#mount-listmounts}
This shows currently mounted points, which can be used for performing an unmount
This shows currently mounted points, which can be used for performing an unmount.
This takes no parameters and returns
@@ -988,22 +988,22 @@ Rclone's cloud storage systems as a file system with FUSE.
If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2
This takes the following parameters
This takes the following parameters:
- fs - a remote path to be mounted (required)
- mountPoint: valid path on the local machine (required)
- mountType: One of the values (mount, cmount, mount2) specifies the mount implementation to use
- mountType: one of the values (mount, cmount, mount2) specifies the mount implementation to use
- mountOpt: a JSON object with Mount options in.
- vfsOpt: a JSON object with VFS options in.
Eg
Example:
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount
rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}'
The vfsOpt are as described in options/get and can be seen in the the
"vfs" section when running and the mountOpt can be seen in the "mount" section.
"vfs" section when running and the mountOpt can be seen in the "mount" section:
rclone rc options/get
@@ -1032,11 +1032,11 @@ rclone allows Linux, FreeBSD, macOS and Windows to
mount any of Rclone's cloud storage systems as a file system with
FUSE.
This takes the following parameters
This takes the following parameters:
- mountPoint: valid path on the local machine where the mount was created (required)
Eg
Example:
rclone rc mount/unmount mountPoint=/home/<user>/mountPoint
@@ -1044,7 +1044,7 @@ Eg
### mount/unmountall: Show current mount points {#mount-unmountall}
This shows currently mounted points, which can be used for performing an unmount
This shows currently mounted points, which can be used for performing an unmount.
This takes no parameters and returns error if unmount does not succeed.
@@ -1056,7 +1056,7 @@ Eg
### operations/about: Return the space used on the remote {#operations-about}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
@@ -1068,7 +1068,7 @@ See the [about command](/commands/rclone_size/) command for more information on
### operations/cleanup: Remove trashed files in the remote or path {#operations-cleanup}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
@@ -1078,7 +1078,7 @@ See the [cleanup command](/commands/rclone_cleanup/) command for more informatio
### operations/copyfile: Copy a file from source remote to destination remote {#operations-copyfile}
This takes the following parameters
This takes the following parameters:
- srcFs - a remote name string e.g. "drive:" for the source
- srcRemote - a path within that remote e.g. "file.txt" for the source
@@ -1089,7 +1089,7 @@ This takes the following parameters
### operations/copyurl: Copy the URL to the object {#operations-copyurl}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
@@ -1101,7 +1101,7 @@ See the [copyurl command](/commands/rclone_copyurl/) command for more informatio
### operations/delete: Remove files in the path {#operations-delete}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
@@ -1111,7 +1111,7 @@ See the [delete command](/commands/rclone_delete/) command for more information
### operations/deletefile: Remove the single file pointed to {#operations-deletefile}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
@@ -1122,7 +1122,7 @@ See the [deletefile command](/commands/rclone_deletefile/) command for more info
### operations/fsinfo: Return information about the remote {#operations-fsinfo}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
@@ -1179,7 +1179,7 @@ This command does not have a command line equivalent so use this instead:
### operations/list: List the given remote and path in JSON format {#operations-list}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
@@ -1189,8 +1189,12 @@ This takes the following parameters
- showEncrypted - If set show decrypted names
- showOrigIDs - If set show the IDs for each item if known
- showHash - If set return a dictionary of hashes
- noMimeType - If set don't show mime types
- dirsOnly - If set only show directories
- filesOnly - If set only show files
- hashTypes - array of strings of hash types to show if showHash set
The result is
Returns:
- list
- This is an array of objects as described in the lsjson command
@@ -1201,7 +1205,7 @@ See the [lsjson command](/commands/rclone_lsjson/) for more information on the a
### operations/mkdir: Make a destination directory or container {#operations-mkdir}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
@@ -1212,7 +1216,7 @@ See the [mkdir command](/commands/rclone_mkdir/) command for more information on
### operations/movefile: Move a file from source remote to destination remote {#operations-movefile}
This takes the following parameters
This takes the following parameters:
- srcFs - a remote name string e.g. "drive:" for the source
- srcRemote - a path within that remote e.g. "file.txt" for the source
@@ -1223,14 +1227,14 @@ This takes the following parameters
### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations-publiclink}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
- unlink - boolean - if set removes the link rather than adding it (optional)
- expire - string - the expiry time of the link e.g. "1d" (optional)
Returns
Returns:
- url - URL of the resource
@@ -1240,7 +1244,7 @@ See the [link command](/commands/rclone_link/) command for more information on t
### operations/purge: Remove a directory or container and all of its contents {#operations-purge}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
@@ -1251,7 +1255,7 @@ See the [purge command](/commands/rclone_purge/) command for more information on
### operations/rmdir: Remove an empty directory or container {#operations-rmdir}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
@@ -1262,23 +1266,22 @@ See the [rmdir command](/commands/rclone_rmdir/) command for more information on
### operations/rmdirs: Remove all the empty directories in the path {#operations-rmdirs}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
- leaveRoot - boolean, set to true not to delete the root
See the [rmdirs command](/commands/rclone_rmdirs/) command for more information on the above.
**Authentication is required for this call.**
### operations/size: Count the number of bytes and files in remote {#operations-size}
This takes the following parameters
This takes the following parameters:
- fs - a remote name string e.g. "drive:path/to/dir"
Returns
Returns:
- count - number of files
- bytes - number of bytes in those files
@@ -1287,10 +1290,30 @@ See the [size command](/commands/rclone_size/) command for more information on t
**Authentication is required for this call.**
### operations/uploadfile: Upload file using multiform/form-data {#operations-uploadfile}
### operations/stat: Give information about the supplied file or directory {#operations-stat}
This takes the following parameters
- fs - a remote name string eg "drive:"
- remote - a path within that remote eg "dir"
- opt - a dictionary of options to control the listing (optional)
- see operations/list for the options
The result is
- item - an object as described in the lsjson command. Will be null if not found.
Note that if you are only interested in files then it is much more
efficient to set the filesOnly flag in the options.
See the [lsjson command](/commands/rclone_lsjson/) for more information on the above and examples.
**Authentication is required for this call.**
### operations/uploadfile: Upload file using multiform/form-data {#operations-uploadfile}
This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
- each part in body represents a file to be uploaded
@@ -1300,7 +1323,7 @@ See the [uploadfile command](/commands/rclone_uploadfile/) command for more info
### options/blocks: List all the option blocks {#options-blocks}
Returns
Returns:
- options - a list of the options block names
### options/get: Get all the global options {#options-get}
@@ -1333,7 +1356,7 @@ map to the external options very easily with a few exceptions.
### options/set: Set an option {#options-set}
Parameters
Parameters:
- option block name containing an object with
- key: value
@@ -1361,13 +1384,13 @@ And this sets NOTICE level logs (normal without -v)
### pluginsctl/addPlugin: Add a plugin using url {#pluginsctl-addPlugin}
used for adding a plugin to the webgui
Used for adding a plugin to the webgui.
This takes the following parameters
This takes the following parameters:
- url: http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone-webui-react)
- url - http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone-webui-react).
Eg
Example:
rclone rc pluginsctl/addPlugin
@@ -1375,19 +1398,19 @@ Eg
### pluginsctl/getPluginsForType: Get plugins with type criteria {#pluginsctl-getPluginsForType}
This shows all possible plugins by a mime type
This shows all possible plugins by a mime type.
This takes the following parameters
This takes the following parameters:
- type: supported mime type by a loaded plugin e.g. (video/mp4, audio/mp3)
- pluginType: filter plugins based on their type e.g. (DASHBOARD, FILE_HANDLER, TERMINAL)
- type - supported mime type by a loaded plugin e.g. (video/mp4, audio/mp3).
- pluginType - filter plugins based on their type e.g. (DASHBOARD, FILE_HANDLER, TERMINAL).
and returns
Returns:
- loadedPlugins: list of current production plugins
- testPlugins: list of temporarily loaded development plugins, usually running on a different server.
- loadedPlugins - list of current production plugins.
- testPlugins - list of temporarily loaded development plugins, usually running on a different server.
Eg
Example:
rclone rc pluginsctl/getPluginsForType type=video/mp4
@@ -1397,12 +1420,12 @@ Eg
This allows you to get the currently enabled plugins and their details.
This takes no parameters and returns
This takes no parameters and returns:
- loadedPlugins: list of current production plugins
- testPlugins: list of temporarily loaded development plugins, usually running on a different server.
- loadedPlugins - list of current production plugins.
- testPlugins - list of temporarily loaded development plugins, usually running on a different server.
Eg
E.g.
rclone rc pluginsctl/listPlugins
@@ -1410,13 +1433,13 @@ Eg
### pluginsctl/listTestPlugins: Show currently loaded test plugins {#pluginsctl-listTestPlugins}
allows listing of test plugins with the rclone.test set to true in package.json of the plugin
Allows listing of test plugins with the rclone.test set to true in package.json of the plugin.
This takes no parameters and returns
This takes no parameters and returns:
- loadedTestPlugins: list of currently available test plugins
- loadedTestPlugins - list of currently available test plugins.
Eg
E.g.
rclone rc pluginsctl/listTestPlugins
@@ -1424,13 +1447,13 @@ Eg
### pluginsctl/removePlugin: Remove a loaded plugin {#pluginsctl-removePlugin}
This allows you to remove a plugin using it's name
This allows you to remove a plugin using it's name.
This takes parameters
This takes parameters:
- name: name of the plugin in the format `author`/`plugin_name`
- name - name of the plugin in the format `author`/`plugin_name`.
Eg
E.g.
rclone rc pluginsctl/removePlugin name=rclone/video-plugin
@@ -1438,13 +1461,13 @@ Eg
### pluginsctl/removeTestPlugin: Remove a test plugin {#pluginsctl-removeTestPlugin}
This allows you to remove a plugin using it's name
This allows you to remove a plugin using it's name.
This takes the following parameters
This takes the following parameters:
- name: name of the plugin in the format `author`/`plugin_name`
- name - name of the plugin in the format `author`/`plugin_name`.
Eg
Example:
rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react
@@ -1476,7 +1499,7 @@ check that parameter passing is working properly.
### sync/copy: copy a directory from source remote to destination remote {#sync-copy}
This takes the following parameters
This takes the following parameters:
- srcFs - a remote name string e.g. "drive:src" for the source
- dstFs - a remote name string e.g. "drive:dst" for the destination
@@ -1489,7 +1512,7 @@ See the [copy command](/commands/rclone_copy/) command for more information on t
### sync/move: move a directory from source remote to destination remote {#sync-move}
This takes the following parameters
This takes the following parameters:
- srcFs - a remote name string e.g. "drive:src" for the source
- dstFs - a remote name string e.g. "drive:dst" for the destination
@@ -1503,7 +1526,7 @@ See the [move command](/commands/rclone_move/) command for more information on t
### sync/sync: sync a directory from source remote to destination remote {#sync-sync}
This takes the following parameters
This takes the following parameters:
- srcFs - a remote name string e.g. "drive:src" for the source
- dstFs - a remote name string e.g. "drive:dst" for the destination