v1.37

rclone ncdu

Explore a remote with a text based user interface.

Synopsis

This displays a text based user interface allowing the navigation of a remote. It is most useful for answering the question - “What is using all my disk space?”.

To make the user interface it first scans the entire remote given and builds an in memory representation. rclone ncdu can be used during this scanning phase and you will see it building up the directory structure as it goes along.

You can interact with the user interface using key presses, press ‘?’ to toggle the help on and off. The supported keys are:

  1.  ↑,↓ or k,j to Move
  2.  →,l to enter
  3.  ←,h to return
  4.  g toggle graph
  5.  c toggle counts
  6.  a toggle average size in directory
  7.  m toggle modified time
  8.  u toggle human-readable format
  9.  n,s,C,A,M sort by name,size,count,asize,mtime
  10.  d delete file/directory
  11.  v select file/directory
  12.  V enter visual select mode
  13.  D delete selected files/directories
  14.  y copy current path to clipboard
  15.  Y display current path
  16.  ^L refresh screen (fix screen corruption)
  17.  r recalculate file sizes
  18.  ? to toggle help on and off
  19.  ESC to close the menu box
  20.  q/^c to quit

Listed files/directories may be prefixed by a one-character flag, some of them combined with a description in brackets at end of line. These flags have the following meaning:

  1. e means this is an empty directory, i.e. contains no files (but
  2.   may contain empty subdirectories)
  3. ~ means this is a directory where some of the files (possibly in
  4.   subdirectories) have unknown size, and therefore the directory
  5.   size may be underestimated (and average size inaccurate, as it
  6.   is average of the files with known sizes).
  7. . means an error occurred while reading a subdirectory, and
  8.   therefore the directory size may be underestimated (and average
  9.   size inaccurate)
  10. ! means an error occurred while reading this directory

This an homage to the ncdu tool but for rclone remotes. It is missing lots of features at the moment but is useful as it stands. Unlike ncdu it does not show excluded files.

Note that it might take some time to delete big files/directories. The UI won’t respond in the meantime since the deletion is done synchronously.

For a non-interactive listing of the remote, see the tree command. To just get the total size of the remote you can also use the size command.

  1. rclone ncdu remote:path [flags]

Options

  1.   -h, --help   help for ncdu

Options shared with other commands are described next. See the global flags page for global options not listed here.

Filter Options

Flags for filtering directory listings

  1.       --delete-excluded                     Delete files on dest excluded from sync
  2.       --exclude stringArray                 Exclude files matching pattern
  3.       --exclude-from stringArray            Read file exclude patterns from file (use - to read from stdin)
  4.       --exclude-if-present stringArray      Exclude directories if filename is present
  5.       --files-from stringArray              Read list of source-file names from file (use - to read from stdin)
  6.       --files-from-raw stringArray          Read list of source-file names from file without any processing of lines (use - to read from stdin)
  7.   -f, --filter stringArray                  Add a file filtering rule
  8.       --filter-from stringArray             Read file filtering patterns from a file (use - to read from stdin)
  9.       --ignore-case                         Ignore case in filters (case insensitive)
  10.       --include stringArray                 Include files matching pattern
  11.       --include-from stringArray            Read file include patterns from file (use - to read from stdin)
  12.       --max-age Duration                    Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
  13.       --max-depth int                       If set limits the recursion depth to this (default -1)
  14.       --max-size SizeSuffix                 Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
  15.       --metadata-exclude stringArray        Exclude metadatas matching pattern
  16.       --metadata-exclude-from stringArray   Read metadata exclude patterns from file (use - to read from stdin)
  17.       --metadata-filter stringArray         Add a metadata filtering rule
  18.       --metadata-filter-from stringArray    Read metadata filtering patterns from a file (use - to read from stdin)
  19.       --metadata-include stringArray        Include metadatas matching pattern
  20.       --metadata-include-from stringArray   Read metadata include patterns from file (use - to read from stdin)
  21.       --min-age Duration                    Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
  22.       --min-size SizeSuffix                 Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)

Listing Options

Flags for listing directories

  1.       --default-time Time   Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
  2.       --fast-list           Use recursive list if available; uses more memory but fewer transactions

See Also

  • rclone - Show help for rclone commands, flags and backends.