github.com/artpar/rclone@v1.67.3/docs/content/commands/rclone_cat.md (about)

     1  ---
     2  title: "rclone cat"
     3  description: "Concatenates any files and sends them to stdout."
     4  slug: rclone_cat
     5  url: /commands/rclone_cat/
     6  groups: Filter,Listing
     7  versionIntroduced: v1.33
     8  # autogenerated - DO NOT EDIT, instead edit the source code in cmd/cat/ and as part of making a release run "make commanddocs"
     9  ---
    10  # rclone cat
    11  
    12  Concatenates any files and sends them to stdout.
    13  
    14  ## Synopsis
    15  
    16  
    17  rclone cat sends any files to standard output.
    18  
    19  You can use it like this to output a single file
    20  
    21      rclone cat remote:path/to/file
    22  
    23  Or like this to output any file in dir or its subdirectories.
    24  
    25      rclone cat remote:path/to/dir
    26  
    27  Or like this to output any .txt files in dir or its subdirectories.
    28  
    29      rclone --include "*.txt" cat remote:path/to/dir
    30  
    31  Use the `--head` flag to print characters only at the start, `--tail` for
    32  the end and `--offset` and `--count` to print a section in the middle.
    33  Note that if offset is negative it will count from the end, so
    34  `--offset -1 --count 1` is equivalent to `--tail 1`.
    35  
    36  Use the `--separator` flag to print a separator value between files. Be sure to
    37  shell-escape special characters. For example, to print a newline between
    38  files, use:
    39  
    40  * bash:
    41  
    42        rclone --include "*.txt" --separator $'\n' cat remote:path/to/dir
    43  
    44  * powershell:
    45  
    46        rclone --include "*.txt" --separator "`n" cat remote:path/to/dir
    47  
    48  
    49  ```
    50  rclone cat remote:path [flags]
    51  ```
    52  
    53  ## Options
    54  
    55  ```
    56        --count int          Only print N characters (default -1)
    57        --discard            Discard the output instead of printing
    58        --head int           Only print the first N characters
    59    -h, --help               help for cat
    60        --offset int         Start printing at offset N (or from end if -ve)
    61        --separator string   Separator to use between objects when printing multiple files
    62        --tail int           Only print the last N characters
    63  ```
    64  
    65  
    66  ## Filter Options
    67  
    68  Flags for filtering directory listings.
    69  
    70  ```
    71        --delete-excluded                     Delete files on dest excluded from sync
    72        --exclude stringArray                 Exclude files matching pattern
    73        --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
    74        --exclude-if-present stringArray      Exclude directories if filename is present
    75        --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
    76        --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
    77    -f, --filter stringArray                  Add a file filtering rule
    78        --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
    79        --ignore-case                         Ignore case in filters (case insensitive)
    80        --include stringArray                 Include files matching pattern
    81        --include-from stringArray            Read file include patterns from file (use - to read from stdin)
    82        --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
    83        --max-depth int                       If set limits the recursion depth to this (default -1)
    84        --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
    85        --metadata-exclude stringArray        Exclude metadatas matching pattern
    86        --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
    87        --metadata-filter stringArray         Add a metadata filtering rule
    88        --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
    89        --metadata-include stringArray        Include metadatas matching pattern
    90        --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
    91        --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
    92        --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
    93  ```
    94  
    95  ## Listing Options
    96  
    97  Flags for listing directories.
    98  
    99  ```
   100        --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
   101        --fast-list           Use recursive list if available; uses more memory but fewer transactions
   102  ```
   103  
   104  See the [global flags page](/flags/) for global options not listed here.
   105  
   106  # SEE ALSO
   107  
   108  * [rclone](/commands/rclone/)	 - Show help for rclone commands, flags and backends.
   109