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