Home > Solutions > Open Source > s3cp

S3cp

s3cp - Amazon S3 command line cp program

"As a user of Amazon's S3 service for hosting files and storing backups I've longed for a simple command line copy progam. s3cp is the result." - Brad Lucas

S3cp works like the Unix cp program allowing you to put files into S3 or to retrieve them from the command line.

Amazon Simple Storage Service (Amazon S3)

Amazon Simple Storage Service (Amazon S3) is storage for the Internet provided by Amazon through their Amazon Web Services (AWS) cloud computing effort. Beacon Hill has used S3 for a number of projects and has found it to be a very useful and reliable storage mechanism.

Full details about S3 are available at http://aws.amazon.com/s3/

Amazon's Sample Code & Libraries has s3cp listed. See http://developer.amazonwebservices.com/connect/entry.jspa?categoryID=188&externalID=3124

Downloads

• s3cp.zip
• s3cp.tar.gz

News

• http://www.entirelyopensource.com/
• Beacon Hill, Inc. releases S3cp as Open Source

Notifications

We enhance and fix s3cp frequently. If you'd like to know when please enter your email address.

Basic Installation

Unpack the downloaded zip or tar.gz file.

The dist folder will contain the compiled application as s3cp-cmdline.jar.

You need a java virtual machine installed, for both compiling and starting s3cp.

Next, cd into /s3cp/dist and enter from the command-line the following:

java -jar s3cp-cmdline.jar -h

You'll get the command line syntax.

Amazon Keys

Before you can interact with your S3 account you need to setup a file with your access and secret key.

Create a directory called .s3cp under your home directory.

Inside the directory create a file called s3cp.properties

In the s3cp.properties file create the following entries:

s3.accessKey=YOUR-VALUE-HEREs3.secretKey=YOUR-VALUE-HERE

Alias

There is a script called s3cp.sh in ~/secp/src/scripts that you setup with an alias.

Edit the following with the correct path and put in your .bashrc file

alias s3cp=$HOME/work/s3cp/src/scripts/s3cp.sh

With that, s3cp will run from the command line through the alias

Usage

s3cp uses a URI syntax to reference the objects in your S3 account. For example, if you have a bucket called test-files with an object tmp/test.sh you'd be able to get it from S3 with the following command.

$ s3cp s3://test-files/tmp/test.sh test.sh

Copy to S3 [PUT]

    $ s3cp local-file s3://bucket/object[/]

    If object has a trailing slash it will be assumed to mean a directory
    and the local-file's filename will be appended to object.

Copy from S3 [GET]

    $ s3cp s3://bucket/object [local-file]


    If local-file is not present a filename from object will be used in 
    the current directory.

Feedback

If you try s3cp and have a suggestion please let me know.

brad@beaconhill.com

If you'd like to know when a new version is put up visit the following pageand enter your email in the signup for updates box.

http://www.beaconhill.com/opensource/s3cp.html