`bm rb`

Syntax

The bm rb command removes one or more buckets on Buckit or another S3-compatible service.

To remove only the contents of a bucket, use bm rm instead.

Important

bm rb permanently deletes bucket(s) on the target deployment, including any and all object versions and bucket configurations such as lifecycle management or replication.

You can also use bm rb against the local filesystem to produce similar results to the rm --rf commandline tool.

EXAMPLE

The following command removes the mydata bucket on the mybuckit Buckit deployment:

bm rb --force mybuckit/mydata

SYNTAX

The command has the following syntax:

bm [GLOBALFLAGS] rb             \
                 --force        \
                 [--dangerous]  \
                 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 or other S3-compatible service and the full path to the bucket to remove. For example:

bm rb --force mybuckit/mydata

Omit the bucket path to perform a site-wide removal of buckets on the Buckit deployment. This operation requires specifying --dangerous to explicitly acknowledge the permanent removal of all data on the deployment. For example:

bm rb --force --dangerous mybuckit

For removing a directory and its contents on a local filesystem, specify the full path to that directory. The --force flag is ignored if specified. For example:

bm rb ~/data/myolddata

You can specify multiple ALIAS targets consisting of either Buckit or local filesystem directories. The command attempts to remove all specified targets. For example:

bm rb --force mybuckit/mydata ~/data/myolddata

--force: Required Safety flag to confirm removal of the bucket contents.

--dangerous

Optional Directs bm rb to perform a site-wide removal of all buckets on each specified ALIAS (e.g. mybuckit/).

If any ALIAS specifies a filesystem directory, this option results in the removal of all subdirectories and files at that directory path similar to rm --rf.

Warning

Running bm rb --dangerous is irreversible. Exercise all possible due diligence in ensuring the command applies to only the desired ALIAS targets prior to execution.

Global Flags

This command supports any of the global flags.

Example

Remove a Bucket

bm rb --force ALIAS/PATH

Replace ALIAS with the alias of a configured S3-compatible host.
Replace PATH with the path to the bucket to remove.

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.