rclone/docs/content/commands/rclone_ls.md

102 lines
4.2 KiB
Markdown
Raw Normal View History

---
title: "rclone ls"
description: "List the objects in the path with size and path."
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/ls/ and as part of making a release run "make commanddocs"
---
# rclone ls
2018-03-19 11:06:13 +01:00
List the objects in the path with size and path.
## Synopsis
2018-03-19 11:06:13 +01:00
Lists the objects in the source path to standard output in a human
readable format with size and path. Recurses by default.
2018-04-28 12:46:27 +02:00
Eg
$ rclone ls swift:bucket
60295 bevajer5jef
90613 canole
94467 diwogej7
37600 fubuwic
Any of the filtering options can be applied to this command.
2018-03-19 11:06:13 +01:00
There are several related list commands
* `ls` to list size and path of objects only
* `lsl` to list modification time, size and path of objects only
* `lsd` to list directories only
* `lsf` to list objects and directories in easy to parse format
* `lsjson` to list objects and directories in JSON format
2022-03-18 13:29:54 +01:00
`ls`,`lsl`,`lsd` are designed to be human-readable.
`lsf` is designed to be human and machine-readable.
`lsjson` is designed to be machine-readable.
2018-03-19 11:06:13 +01:00
2021-02-02 14:42:35 +01:00
Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion.
2018-04-28 12:46:27 +02:00
2021-02-02 14:42:35 +01:00
The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse.
2018-03-19 11:06:13 +01:00
2022-10-21 16:06:08 +02:00
Listing a nonexistent directory will produce an error except for
2021-02-02 14:42:35 +01:00
remotes which can't have empty directories (e.g. s3, swift, or gcs -
2022-03-18 13:29:54 +01:00
the bucket-based remotes).
2018-03-19 11:06:13 +01:00
```
2017-09-30 15:19:47 +02:00
rclone ls remote:path [flags]
```
## Options
2017-09-30 15:19:47 +02:00
```
-h, --help help for ls
```
2024-09-08 17:21:56 +02:00
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
2023-08-02 11:02:38 +02:00
2024-09-08 17:21:56 +02:00
### Filter Options
2023-08-02 11:02:38 +02:00
2024-09-08 17:21:56 +02:00
Flags for filtering directory listings
2023-08-02 11:02:38 +02:00
```
--delete-excluded Delete files on dest excluded from sync
--exclude stringArray Exclude files matching pattern
--exclude-from stringArray Read file exclude patterns from file (use - to read from stdin)
--exclude-if-present stringArray Exclude directories if filename is present
--files-from stringArray Read list of source-file names from file (use - to read from stdin)
--files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin)
-f, --filter stringArray Add a file filtering rule
--filter-from stringArray Read file filtering patterns from a file (use - to read from stdin)
--ignore-case Ignore case in filters (case insensitive)
--include stringArray Include files matching pattern
--include-from stringArray Read file include patterns from file (use - to read from stdin)
--max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--max-depth int If set limits the recursion depth to this (default -1)
--max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
--metadata-exclude stringArray Exclude metadatas matching pattern
--metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin)
--metadata-filter stringArray Add a metadata filtering rule
--metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin)
--metadata-include stringArray Include metadatas matching pattern
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
```
2024-09-08 17:21:56 +02:00
### Listing Options
2023-08-02 11:02:38 +02:00
2024-09-08 17:21:56 +02:00
Flags for listing directories
2023-08-02 11:02:38 +02:00
```
--default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions
```
2024-09-08 17:21:56 +02:00
## See Also
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