DearS3

Command line tools to mirror your current directory in an AWS bucket.

Set up

Installation

Run gem install dears3 from the command line. Only works on *NIX systems.

AWS Credentials

This CLI will look in your home directory for a file called ".aws.json" that contains the JSON string of your AWS credentials.

{
  "access_key_id": "YOUR_ACCESS_KEY_ID",
  "secret_access_key": "YOUR_SECRET_ACCESS_KEY"
}

To get these credentials, log into your AWS S3 console, click on your name in the navigation menu and open "Security Credentials". See here for more details.

Tasks

s3 auth

Prompts you for your AWS credentials and stores them in your home directory in a file called ".aws.json".

s3 upload

Uploads every file in the current directory and its subdirectories to an AWS bucket. Any file beginning with "." is ignored. It syncs to arbitary levels of nesting so be careful with symlinks that could cause an infinite loop.

The bucket will take the name of the current directory, replacing underscores with dashes. Note that the bucket's name must conform with DNS requirements if you plan on publishing it as a website.

Caution: If a bucket with that name already exists and contains files with the same names as the files in your directory, those files will be overriden without warning.

Run s3 upload --publish to publish your uploaded files as a website.

s3 publish

Publishes the current directory as a website. Directory must already be uploaded to s3. Run s3 publish --off to roll back.

Contributing

1. Fork it ( https://github.com/[my-github-username]/dears3/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request