Project

dears3

0.0
No commit activity in last 3 years
No release in over 3 years
Sync an S3 bucket with your current directory.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
>= 0
>= 0
>= 0

Runtime

~> 1.59.x
= 2.4.3
~> 2.x
~> 0.19.x
 Project Readme

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 for now.

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. If the bucket name is invalid or unavaiable, you will be prompted to specify the bucket's name.

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.

s3 publish

Publishes the current directory as a website. Requires at least one file in the directory to be uploaded.

Contributing

  1. Fork it ( https://github.com/7imon7ays/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