rclone/docs/content/commands/rclone_backend.md

73 lines
1.9 KiB
Markdown
Raw Normal View History

---
title: "rclone backend"
2022-03-18 23:29:54 +11:00
description: "Run a backend-specific command."
slug: rclone_backend
url: /commands/rclone_backend/
2023-08-02 19:02:38 +10:00
groups: Important
2022-12-21 04:16:14 +11:00
versionIntroduced: v1.52
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/backend/ and as part of making a release run "make commanddocs"
---
# rclone backend
2022-03-18 23:29:54 +11:00
Run a backend-specific command.
## Synopsis
2022-03-18 23:29:54 +11:00
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
2022-03-18 23:29:54 +11:00
[operations/fsinfo](/rc/#operations-fsinfo) in the remote control docs
for more info).
rclone backend features remote:
2021-02-03 00:42:35 +11:00
Pass options to the backend command with -o. This should be key=value or key, e.g.:
rclone backend stats remote:path stats -o format=json -o long
Pass arguments to the backend by placing them on the end of the line
rclone backend cleanup remote:path file1 file2 file3
Note to run these commands on a running backend then see
2022-03-18 23:29:54 +11:00
[backend/command](/rc/#backend-command) in the rc docs.
```
rclone backend <command> remote:path [opts] <args> [flags]
```
## Options
```
-h, --help help for backend
2021-11-02 02:42:05 +11:00
--json Always output in JSON format
-o, --option stringArray Option in the form name=value or name
```
2023-08-02 19:02:38 +10:00
## 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](/flags/) for global options not listed here.
2023-08-02 19:02:38 +10:00
# SEE ALSO
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.