Skip to main content
S3cmd
Last update:

S3cmd

S3cmd — is a command-line interface for working with services that support Amazon's S3 HTTP API ( S3 API).

Customize S3cmd⁠

  1. Configure access.
  2. Install the client.
  3. Create an S3cmd configuration.

1. Set up access⁠

Access can be configured by a user with the Account Owner or User Administrator role.

  1. Create a service user с role with access to the object store.If you are using a user with the Object Storage User role, the container must have a configured access policy.
  2. Issue an S3 key to the user.

2. Install the client⁠

From GitHub S3cmd, download and install the client.

3. Create s3cmd configuration⁠

  1. Open the terminal.

  2. Open the configuration mode:

    s3cmd --configure

  3. Enter Access Key — the value of the Access key field from the S3 key.

  4. Enter Secret Key — the value of the Secret key field from the S3 key.

  5. Enter Default Region — Pool.

  6. Enter S3 Endpoint — S3 API domain, depends on the pool where the object store resides.

  7. Enter DNS-style bucket+hostname:port template for accessing a bucket — the domain of the S3 API, depends on the pool where the object store resides. The settings will be saved in the ~/.s3cfg file:

    [default]
       access_key = <access_key>
       secret_key = <secret_key>
       bucket_location = <pool>
       host_base = <s3_domain>
       host_bucket = <s3_domain>

Working with S3cmd⁠

You can see all commands in the Usage instructions of the S3cmd documentation.

Create a container⁠

Create a container:

s3cmd mb s3://<container_name>

Specify <container_name> is the name of the new container.

View list of objects⁠

Check out the list of facilities:

s3cmd ls s3://<container_name>

Specify <container_name> is the name of the container.

Load object⁠

Load the object:

s3cmd put <path> s3://<container_name>/<prefix>

Specify:

  • <path> — path to a file in the local directory;
  • <container_name> — container name;
  • <prefix> — Optional: prefix by which the object will be loaded.

Delete object⁠

Delete the object:

s3cmd rm s3://<container_name>/<object_name>

Specify:

  • <container_name> — container name;
  • <object_name> — object name.