rclone/docs/content/commands/rclone_tree.md

113 lines
5.0 KiB
Markdown
Raw Normal View History

2017-09-30 21:19:47 +08:00
---
title: "rclone tree"
description: "List the contents of the remote in a tree like fashion."
2022-12-21 01:16:14 +08:00
versionIntroduced: v1.38
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/tree/ and as part of making a release run "make commanddocs"
2017-09-30 21:19:47 +08:00
---
# rclone tree
2017-09-30 21:19:47 +08:00
List the contents of the remote in a tree like fashion.
## Synopsis
2017-09-30 21:19:47 +08:00
2024-09-08 23:21:56 +08:00
Lists the contents of a remote in a similar way to the unix tree command.
2017-09-30 21:19:47 +08:00
For example
$ rclone tree remote:path
/
├── file1
├── file2
├── file3
└── subdir
├── file4
└── file5
2022-03-18 20:29:54 +08:00
2017-09-30 21:19:47 +08:00
1 directories, 5 files
2021-02-02 21:42:35 +08:00
You can use any of the filtering options with the tree command (e.g.
2022-07-10 01:08:20 +08:00
`--include` and `--exclude`. You can also use `--fast-list`.
2017-09-30 21:19:47 +08:00
The tree command has many options for controlling the listing which
2022-07-10 01:08:20 +08:00
are compatible with the tree command, for example you can include file
sizes with `--size`. Note that not all of them have
2017-09-30 21:19:47 +08:00
short options as they conflict with rclone's short options.
2022-07-10 01:08:20 +08:00
For a more interactive navigation of the remote see the
[ncdu](/commands/rclone_ncdu/) command.
2017-09-30 21:19:47 +08:00
```
rclone tree remote:path [flags]
```
## Options
2017-09-30 21:19:47 +08:00
```
2021-11-01 23:42:05 +08:00
-a, --all All files are listed (list . files too)
-d, --dirs-only List directories only
--dirsfirst List directories before files (-U disables)
--full-path Print the full path prefix for each file
2017-09-30 21:19:47 +08:00
-h, --help help for tree
2021-11-01 23:42:05 +08:00
--level int Descend only level directories deep
2017-09-30 21:19:47 +08:00
-D, --modtime Print the date of last modification.
2021-11-01 23:42:05 +08:00
--noindent Don't print indentation lines
--noreport Turn off file/directory count at end of tree listing
-o, --output string Output to file instead of stdout
2017-09-30 21:19:47 +08:00
-p, --protections Print the protections for each file.
-Q, --quote Quote filenames with double quotes.
-s, --size Print the size in bytes of each file.
2021-11-01 23:42:05 +08:00
--sort string Select sort: name,version,size,mtime,ctime
--sort-ctime Sort files by last status change time
-t, --sort-modtime Sort files by last modification time
-r, --sort-reverse Reverse the order of the sort
-U, --unsorted Leave files unsorted
--version Sort files alphanumerically by version
2017-09-30 21:19:47 +08:00
```
2024-09-08 23:21:56 +08:00
Options shared with other commands are described next.
See the [global flags page](/flags/) for global options not listed here.
2023-08-02 17:02:38 +08:00
2024-09-08 23:21:56 +08:00
### Filter Options
2023-08-02 17:02:38 +08:00
2024-09-08 23:21:56 +08:00
Flags for filtering directory listings
2023-08-02 17:02:38 +08: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 23:21:56 +08:00
### Listing Options
2023-08-02 17:02:38 +08:00
2024-09-08 23:21:56 +08:00
Flags for listing directories
2023-08-02 17:02:38 +08: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 23:21:56 +08:00
## See Also
2017-09-30 21:19:47 +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