s3cmd

Retrieved from https://docs.outscale.com/en/userguide/s3cmd.html (2025-04-23T12:37:23.177Z)

s3cmd is a tool developed in Python that enables you to manage object storage buckets with Unix-like commands.

On January 16, 2025, Amazon Web Services (AWS) introduced new default algorithms for integrity protection when uploading and downloading data using the S3 API. For more information, see AWS SDK and CLI Compatibility Warning.

Installation

If you already have Python installed on your machine, s3cmd is available through the pip utility.

To install s3cmd, run the following command:

$ pip3 install s3cmd
shell

Configuration

In this example, we configure s3cmd for the OUTSCALE Object Storage (OOS) service, on the eu-west-2 Region. For more information about OOS, see About OOS.

  1. Run the following command:

    $ s3cmd --configure
    shell

  2. Specify at least the following settings:

    • Your access key

    • Your secret key

    • Your Region

    • S3 Endpoint: oos.eu-west-2.outscale.com

    • DNS-style bucket+hostname: %(bucket)s.oos.eu-west-2.outscale.com

  3. In your home directory, open the .s3cfg file and modify the website_endpoint entry as follows:

    ~/.s3cfg
    website_endpoint = https://%(bucket)s.oos-website-%(location)s.oos.eu-west-2.outscale.com/
    text

Examples

  • Creating a bucket:

    $ s3cmd mb s3://MY_BUCKET
    shell

  • Listing your buckets:

    $ s3cmd ls
    shell

  • Uploading an object to a bucket:

    $ s3cmd put OBJECT s3://MY_BUCKET
    shell

    You can set up rights as public when adding an object to your bucket by adding the following parameter:

    --acl-public
    text

  • Copying an object:

    $ s3cmd cp s3://MY_BUCKET/OBJECT_TO_COPY s3://MY_BUCKET_FOR_THE_COPY
    shell

  • Listing the content of a bucket:

    $ s3cmd ls s3://my_bucket
    shell

  • Downloading an object from a bucket:

    $ s3cmd get s3://MY_BUCKET/OBJECT NEW_NAME_FOR_THE_DOWNLOADED_OBJECT
    shell

  • Deleting an object:

    $ s3cmd del s3://my_bucket/bar
    shell

  • Signing an OOS URL to provide limited public access with expiry:

    $ s3cmd signurl s3://my_bucket/my_file.png <expiry_in_epoch>
    shell

  • Allowing an object for one week:

    Allow file for 1 week
    $ s3cmd signurl s3://my_bucket/my_file.png $(echo "`date +%s` + 3600 * 24 * 7" | bc)
    shell

  • Deleting a bucket:

    $ s3cmd rb s3://MY_BUCKET
    shell

Related Pages

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.

Export to PDF