rclone/docs/content/commands/rclone_cat.md

106 lines
4.5 KiB
Markdown
Raw Normal View History

2016-10-04 12:30:48 +02:00
---
title: "rclone cat"
description: "Concatenates any files and sends them to stdout."
2022-12-20 18:16:14 +01:00
versionIntroduced: v1.33
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/cat/ and as part of making a release run "make commanddocs"
2016-10-04 12:30:48 +02:00
---
# rclone cat
2016-10-04 12:30:48 +02:00
Concatenates any files and sends them to stdout.
## Synopsis
2016-10-04 12:30:48 +02:00
2024-09-08 17:21:56 +02:00
Sends any files to standard output.
2016-10-04 12:30:48 +02:00
You can use it like this to output a single file
rclone cat remote:path/to/file
Or like this to output any file in dir or its subdirectories.
2016-10-04 12:30:48 +02:00
rclone cat remote:path/to/dir
Or like this to output any .txt files in dir or its subdirectories.
2016-10-04 12:30:48 +02:00
rclone --include "*.txt" cat remote:path/to/dir
2021-02-02 14:42:35 +01:00
Use the `--head` flag to print characters only at the start, `--tail` for
the end and `--offset` and `--count` to print a section in the middle.
2017-03-18 12:16:43 +01:00
Note that if offset is negative it will count from the end, so
2021-02-02 14:42:35 +01:00
`--offset -1 --count 1` is equivalent to `--tail 1`.
2017-03-18 12:16:43 +01:00
Use the `--separator` flag to print a separator value between files. Be sure to
shell-escape special characters. For example, to print a newline between
files, use:
* bash:
rclone --include "*.txt" --separator $'\n' cat remote:path/to/dir
* powershell:
rclone --include "*.txt" --separator "`n" cat remote:path/to/dir
2016-10-04 12:30:48 +02:00
```
rclone cat remote:path [flags]
2016-10-04 12:30:48 +02:00
```
## Options
2017-03-18 12:16:43 +01:00
```
--count int Only print N characters (default -1)
--discard Discard the output instead of printing
--head int Only print the first N characters
-h, --help help for cat
--offset int Start printing at offset N (or from end if -ve)
--separator string Separator to use between objects when printing multiple files
--tail int Only print the last N characters
2017-03-18 12:16:43 +01:00
```
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
2016-10-04 12:30:48 +02:00
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