github.com/artpar/rclone@v1.67.3/docs/content/commands/rclone_rc.md (about)

     1  ---
     2  title: "rclone rc"
     3  description: "Run a command against a running rclone."
     4  slug: rclone_rc
     5  url: /commands/rclone_rc/
     6  versionIntroduced: v1.40
     7  # autogenerated - DO NOT EDIT, instead edit the source code in cmd/rc/ and as part of making a release run "make commanddocs"
     8  ---
     9  # rclone rc
    10  
    11  Run a command against a running rclone.
    12  
    13  ## Synopsis
    14  
    15  
    16  
    17  This runs a command against a running rclone.  Use the `--url` flag to
    18  specify an non default URL to connect on.  This can be either a
    19  ":port" which is taken to mean "http://localhost:port" or a
    20  "host:port" which is taken to mean "http://host:port"
    21  
    22  A username and password can be passed in with `--user` and `--pass`.
    23  
    24  Note that `--rc-addr`, `--rc-user`, `--rc-pass` will be read also for
    25  `--url`, `--user`, `--pass`.
    26  
    27  Arguments should be passed in as parameter=value.
    28  
    29  The result will be returned as a JSON object by default.
    30  
    31  The `--json` parameter can be used to pass in a JSON blob as an input
    32  instead of key=value arguments.  This is the only way of passing in
    33  more complicated values.
    34  
    35  The `-o`/`--opt` option can be used to set a key "opt" with key, value
    36  options in the form `-o key=value` or `-o key`. It can be repeated as
    37  many times as required. This is useful for rc commands which take the
    38  "opt" parameter which by convention is a dictionary of strings.
    39  
    40      -o key=value -o key2
    41  
    42  Will place this in the "opt" value
    43  
    44      {"key":"value", "key2","")
    45  
    46  
    47  The `-a`/`--arg` option can be used to set strings in the "arg" value. It
    48  can be repeated as many times as required. This is useful for rc
    49  commands which take the "arg" parameter which by convention is a list
    50  of strings.
    51  
    52      -a value -a value2
    53  
    54  Will place this in the "arg" value
    55  
    56      ["value", "value2"]
    57  
    58  Use `--loopback` to connect to the rclone instance running `rclone rc`.
    59  This is very useful for testing commands without having to run an
    60  rclone rc server, e.g.:
    61  
    62      rclone rc --loopback operations/about fs=/
    63  
    64  Use `rclone rc` to see a list of all possible commands.
    65  
    66  ```
    67  rclone rc commands parameter [flags]
    68  ```
    69  
    70  ## Options
    71  
    72  ```
    73    -a, --arg stringArray   Argument placed in the "arg" array
    74    -h, --help              help for rc
    75        --json string       Input JSON - use instead of key=value args
    76        --loopback          If set connect to this rclone instance not via HTTP
    77        --no-output         If set, don't output the JSON result
    78    -o, --opt stringArray   Option in the form name=value or name placed in the "opt" array
    79        --pass string       Password to use to connect to rclone remote control
    80        --url string        URL to connect to rclone remote control (default "http://localhost:5572/")
    81        --user string       Username to use to rclone remote control
    82  ```
    83  
    84  
    85  See the [global flags page](/flags/) for global options not listed here.
    86  
    87  # SEE ALSO
    88  
    89  * [rclone](/commands/rclone/)	 - Show help for rclone commands, flags and backends.
    90