rclone/docs/content/commands/rclone_rc.md

94 lines
3.1 KiB
Markdown
Raw Normal View History

2018-03-19 11:06:13 +01:00
---
title: "rclone rc"
description: "Run a command against a running rclone."
2022-12-20 18:16:14 +01:00
versionIntroduced: v1.40
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/rc/ and as part of making a release run "make commanddocs"
2018-03-19 11:06:13 +01:00
---
# rclone rc
2018-03-19 11:06:13 +01:00
Run a command against a running rclone.
## Synopsis
2018-03-19 11:06:13 +01:00
2022-07-09 19:08:20 +02:00
This runs a command against a running rclone. Use the `--url` flag to
2018-11-24 14:44:25 +01:00
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"
2022-07-09 19:08:20 +02:00
A username and password can be passed in with `--user` and `--pass`.
2018-11-24 14:44:25 +01:00
2022-07-09 19:08:20 +02:00
Note that `--rc-addr`, `--rc-user`, `--rc-pass` will be read also for
`--url`, `--user`, `--pass`.
2018-03-19 11:06:13 +01:00
2024-09-08 17:21:56 +02:00
The `--unix-socket` flag can be used to connect over a unix socket like this
# start server on /tmp/my.socket
rclone rcd --rc-addr unix:///tmp/my.socket
# Connect to it
rclone rc --unix-socket /tmp/my.socket core/stats
2018-03-19 11:06:13 +01:00
Arguments should be passed in as parameter=value.
The result will be returned as a JSON object by default.
2022-07-09 19:08:20 +02:00
The `--json` parameter can be used to pass in a JSON blob as an input
2018-11-24 14:44:25 +01:00
instead of key=value arguments. This is the only way of passing in
more complicated values.
2022-07-09 19:08:20 +02:00
The `-o`/`--opt` option can be used to set a key "opt" with key, value
options in the form `-o key=value` or `-o key`. It can be repeated as
many times as required. This is useful for rc commands which take the
"opt" parameter which by convention is a dictionary of strings.
-o key=value -o key2
Will place this in the "opt" value
{"key":"value", "key2","")
2022-07-09 19:08:20 +02:00
The `-a`/`--arg` option can be used to set strings in the "arg" value. It
can be repeated as many times as required. This is useful for rc
commands which take the "arg" parameter which by convention is a list
of strings.
-a value -a value2
Will place this in the "arg" value
["value", "value2"]
2022-07-09 19:08:20 +02:00
Use `--loopback` to connect to the rclone instance running `rclone rc`.
2019-06-15 13:01:29 +02:00
This is very useful for testing commands without having to run an
2021-02-02 14:42:35 +01:00
rclone rc server, e.g.:
2019-06-15 13:01:29 +02:00
rclone rc --loopback operations/about fs=/
2022-07-09 19:08:20 +02:00
Use `rclone rc` to see a list of all possible commands.
2018-03-19 11:06:13 +01:00
```
rclone rc commands parameter [flags]
```
## Options
2018-03-19 11:06:13 +01:00
```
2024-09-08 17:21:56 +02:00
-a, --arg stringArray Argument placed in the "arg" array
-h, --help help for rc
--json string Input JSON - use instead of key=value args
--loopback If set connect to this rclone instance not via HTTP
--no-output If set, don't output the JSON result
-o, --opt stringArray Option in the form name=value or name placed in the "opt" array
--pass string Password to use to connect to rclone remote control
--unix-socket string Path to a unix domain socket to dial to, instead of opening a TCP connection directly
--url string URL to connect to rclone remote control (default "http://localhost:5572/")
--user string Username to use to rclone remote control
2018-03-19 11:06:13 +01:00
```
See the [global flags page](/flags/) for global options not listed here.
2024-09-08 17:21:56 +02:00
## See Also
2018-03-19 11:06:13 +01:00
2018-10-15 12:03:08 +02:00
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
2018-03-19 11:06:13 +01:00