2016-11-06 18:39:25 +08:00
|
|
|
---
|
|
|
|
title: "rclone listremotes"
|
2023-06-15 02:07:43 +08:00
|
|
|
description: "List all the remotes in the config file and defined in environment variables."
|
2022-12-21 01:16:14 +08:00
|
|
|
versionIntroduced: v1.34
|
2020-02-10 20:31:45 +08:00
|
|
|
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/listremotes/ and as part of making a release run "make commanddocs"
|
2016-11-06 18:39:25 +08:00
|
|
|
---
|
2020-05-22 18:17:37 +08:00
|
|
|
# rclone listremotes
|
2016-11-06 18:39:25 +08:00
|
|
|
|
2023-06-30 21:11:17 +08:00
|
|
|
List all the remotes in the config file and defined in environment variables.
|
2016-11-06 18:39:25 +08:00
|
|
|
|
2020-05-22 18:17:37 +08:00
|
|
|
## Synopsis
|
2016-11-06 18:39:25 +08:00
|
|
|
|
|
|
|
|
2024-09-08 23:21:56 +08:00
|
|
|
Lists all the available remotes from the config file, or the remotes matching
|
|
|
|
an optional filter.
|
2016-11-06 18:39:25 +08:00
|
|
|
|
2024-09-08 23:21:56 +08:00
|
|
|
Prints the result in human-readable format by default, and as a simple list of
|
|
|
|
remote names, or if used with flag `--long` a tabular format including
|
|
|
|
the remote names, types and descriptions. Using flag `--json` produces
|
|
|
|
machine-readable output instead, which always includes all attributes - including
|
|
|
|
the source (file or environment).
|
|
|
|
|
|
|
|
Result can be filtered by a filter argument which applies to all attributes,
|
|
|
|
and/or filter flags specific for each attribute. The values must be specified
|
|
|
|
according to regular rclone filtering pattern syntax.
|
2016-11-06 18:39:25 +08:00
|
|
|
|
|
|
|
|
|
|
|
```
|
2024-09-08 23:21:56 +08:00
|
|
|
rclone listremotes [<filter>] [flags]
|
2016-11-06 18:39:25 +08:00
|
|
|
```
|
|
|
|
|
2020-05-22 18:17:37 +08:00
|
|
|
## Options
|
2016-11-06 18:39:25 +08:00
|
|
|
|
|
|
|
```
|
2024-09-08 23:21:56 +08:00
|
|
|
--description string Filter remotes by description
|
|
|
|
-h, --help help for listremotes
|
|
|
|
--json Format output as JSON
|
|
|
|
--long Show type and description in addition to name
|
|
|
|
--name string Filter remotes by name
|
|
|
|
--order-by string Instructions on how to order the result, e.g. 'type,name=descending'
|
|
|
|
--source string Filter remotes by source, e.g. 'file' or 'environment'
|
|
|
|
--type string Filter remotes by type
|
2016-11-06 18:39:25 +08:00
|
|
|
```
|
|
|
|
|
2019-06-20 23:18:02 +08:00
|
|
|
See the [global flags page](/flags/) for global options not listed here.
|
|
|
|
|
2024-09-08 23:21:56 +08:00
|
|
|
## See Also
|
2016-11-06 18:39:25 +08:00
|
|
|
|
2018-10-15 18:03:08 +08:00
|
|
|
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
|
2018-03-19 18:06:13 +08:00
|
|
|
|