`bm du`

Syntax

The bm du command summarizes the disk usage of buckets and folders. You can also use du against the local filesystem to produce similar results as the du command.

EXAMPLE

The following command prints the disk usage of the mybucket bucket on the mybuckit Buckit deployment:

bm du play/mybucket

The output resembles the following:

825KiB 3 objects        mybucket

SYNTAX

The bm du command has the following syntax:

bm [GLOBALFLAGS] du                    \
                 [--depth]             \
                 [--recursive]         \
                 [--rewind]            \
                 [--versions]          \
                 ALIAS [ALIAS ...]

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS

Required

The alias of a Buckit deployment and the full path to the folder. For example:

bm du mybuckit/mybucket

You can specify multiple buckets and folders on the same or different Buckit deployment. For example:

bm du mybuckit/mybucket mybuckit/myotherbucket/myfolder

For a folder on a local filesystem, specify the full path to that folder. For example:

bm du ~/data/images

The time required for bm du to complete depends on the size of the target buckets and folders. A large bucket may take some time to generate a disk usage summary.

--depth, d: Optional
Print the total for all folders N or fewer levels below the path specified in the command. Default is 0, for the specified path only.

--recursive, r: Optional
Recursively print the total for each bucket or child folder.

--rewind

Optional

Directs bm du to operate only on the object version(s) that existed at specified point-in-time.

To rewind to a specific date in the past, specify the date as an ISO8601-formatted timestamp. For example: --rewind "2020.03.24T10:00".
To rewind a duration in time, specify the duration as a string in #d#hh#mm#ss format. For example: --rewind "1d2hh3mm4ss".

--rewind requires that the specified ALIAS be an S3-compatible service that supports Bucket Versioning. For Buckit deployments, use bm version to enable or disable bucket versioning.

Use --rewind and --versions together to show the disk usage for those object versions which existed at a specific point in time.

--versions

Optional

Directs bm du to operate on all object versions that exist in the bucket.

--versions requires that the specified ALIAS be an S3-compatible service that supports Bucket Versioning. For Buckit deployments, use bm version to enable or disable bucket versioning.

Use --versions and --rewind together to show the disk usage for those object versions which existed at a specific point in time.

Global Flags

This command supports any of the global flags.

Examples

View the Disk Usage for a Bucket or Folder

Use bm du to print a summary of the disk usage for a bucket or folder:

bm du ALIAS/PATH

Replace ALIAS with the alias of the S3-compatible host.
Replace PATH with the path to the bucket or folder on the S3-compatible host.

View the Disk Usage at a Point-In-Time

Use bm du --rewind to print a summary of disk usage at a specific point-in-time in the past:

bm du --rewind DURATION ALIAS/PATH

Replace DURATION with the desired point-in-time in the past. For example, specify 30d to show the disk usage 30 days prior to the current date.
Replace ALIAS with the alias of the S3-compatible host.
Replace PATH with the path to the bucket or folder on the S3-compatible host.

Requires Versioning

bm du requires bucket versioning to use this feature. Use bm version to enable versioning on a bucket.

View the Disk Usage Recursively

Use bm du --recursive to print a summary for each folder recursively:

bm du --recursive ALIAS/PATH

Replace ALIAS with the alias of the S3-compatible host.
Replace PATH with the path to the bucket or folder on the S3-compatible host.

Behavior

S3 Compatibility

The bm commandline tool is built for compatibility with the AWS S3 API and is tested with Buckit and AWS S3 for expected functionality and behavior.

Buckit provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While bm commands may work as documented, any such usage is at your own risk.