github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/docs/content/commands/rclone_ncdu.md (about)

     1  ---
     2  title: "rclone ncdu"
     3  description: "Explore a remote with a text based user interface."
     4  slug: rclone_ncdu
     5  url: /commands/rclone_ncdu/
     6  groups: Filter,Listing
     7  versionIntroduced: v1.37
     8  # autogenerated - DO NOT EDIT, instead edit the source code in cmd/ncdu/ and as part of making a release run "make commanddocs"
     9  ---
    10  # rclone ncdu
    11  
    12  Explore a remote with a text based user interface.
    13  
    14  ## Synopsis
    15  
    16  
    17  This displays a text based user interface allowing the navigation of a
    18  remote. It is most useful for answering the question - "What is using
    19  all my disk space?".
    20  
    21  {{< asciinema 157793 >}}
    22  
    23  To make the user interface it first scans the entire remote given and
    24  builds an in memory representation.  rclone ncdu can be used during
    25  this scanning phase and you will see it building up the directory
    26  structure as it goes along.
    27  
    28  You can interact with the user interface using key presses,
    29  press '?' to toggle the help on and off. The supported keys are:
    30  
    31       ↑,↓ or k,j to Move
    32       →,l to enter
    33       ←,h to return
    34       g toggle graph
    35       c toggle counts
    36       a toggle average size in directory
    37       m toggle modified time
    38       u toggle human-readable format
    39       n,s,C,A,M sort by name,size,count,asize,mtime
    40       d delete file/directory
    41       v select file/directory
    42       V enter visual select mode
    43       D delete selected files/directories
    44       y copy current path to clipboard
    45       Y display current path
    46       ^L refresh screen (fix screen corruption)
    47       r recalculate file sizes
    48       ? to toggle help on and off
    49       q/ESC/^c to quit
    50  
    51  Listed files/directories may be prefixed by a one-character flag,
    52  some of them combined with a description in brackets at end of line.
    53  These flags have the following meaning:
    54  
    55      e means this is an empty directory, i.e. contains no files (but
    56        may contain empty subdirectories)
    57      ~ means this is a directory where some of the files (possibly in
    58        subdirectories) have unknown size, and therefore the directory
    59        size may be underestimated (and average size inaccurate, as it
    60        is average of the files with known sizes).
    61      . means an error occurred while reading a subdirectory, and
    62        therefore the directory size may be underestimated (and average
    63        size inaccurate)
    64      ! means an error occurred while reading this directory
    65  
    66  This an homage to the [ncdu tool](https://dev.yorhel.nl/ncdu) but for
    67  rclone remotes.  It is missing lots of features at the moment
    68  but is useful as it stands.
    69  
    70  Note that it might take some time to delete big files/directories. The
    71  UI won't respond in the meantime since the deletion is done synchronously.
    72  
    73  For a non-interactive listing of the remote, see the
    74  [tree](/commands/rclone_tree/) command. To just get the total size of
    75  the remote you can also use the [size](/commands/rclone_size/) command.
    76  
    77  
    78  ```
    79  rclone ncdu remote:path [flags]
    80  ```
    81  
    82  ## Options
    83  
    84  ```
    85    -h, --help   help for ncdu
    86  ```
    87  
    88  
    89  ## Filter Options
    90  
    91  Flags for filtering directory listings.
    92  
    93  ```
    94        --delete-excluded                     Delete files on dest excluded from sync
    95        --exclude stringArray                 Exclude files matching pattern
    96        --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
    97        --exclude-if-present stringArray      Exclude directories if filename is present
    98        --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
    99        --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
   100    -f, --filter stringArray                  Add a file filtering rule
   101        --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
   102        --ignore-case                         Ignore case in filters (case insensitive)
   103        --include stringArray                 Include files matching pattern
   104        --include-from stringArray            Read file include patterns from file (use - to read from stdin)
   105        --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
   106        --max-depth int                       If set limits the recursion depth to this (default -1)
   107        --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
   108        --metadata-exclude stringArray        Exclude metadatas matching pattern
   109        --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
   110        --metadata-filter stringArray         Add a metadata filtering rule
   111        --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
   112        --metadata-include stringArray        Include metadatas matching pattern
   113        --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
   114        --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
   115        --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
   116  ```
   117  
   118  ## Listing Options
   119  
   120  Flags for listing directories.
   121  
   122  ```
   123        --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
   124        --fast-list           Use recursive list if available; uses more memory but fewer transactions
   125  ```
   126  
   127  See the [global flags page](/flags/) for global options not listed here.
   128  
   129  # SEE ALSO
   130  
   131  * [rclone](/commands/rclone/)	 - Show help for rclone commands, flags and backends.
   132