https://github.com/juliankrispel/s3-auto-sync

Watch a folder and upload changes to an s3 bucket.
https://github.com/juliankrispel/s3-auto-sync

aws aws-s3 cli developer-tools s3

Last synced: 9 months ago
JSON representation

Watch a folder and upload changes to an s3 bucket.

• Host: GitHub
• URL: https://github.com/juliankrispel/s3-auto-sync
• Owner: juliankrispel
• License: mit
• Created: 2020-10-24T16:07:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-01T16:46:03.000Z (over 3 years ago)
• Last Synced: 2025-01-06T22:12:26.720Z (over 1 year ago)
• Topics: aws, aws-s3, cli, developer-tools, s3
• Language: JavaScript
• Homepage: https://github.com/juliankrispel/s3-auto-sync
• Size: 486 KB
• Stars: 20
• Watchers: 3
• Forks: 6
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.MD

Awesome Lists containing this project

README

          
# s3-auto-sync

Watches a folder and syncs it to an s3 bucket of your choice. 

![demo](s3-auto-sync.gif)

### Pre-requisites

- You need to have valid aws credentials in your path.

- You need to have at least `PutObject` permission to the bucket.

- Make sure that the bucket you're uploading to or wanting to create is in your local region, otherwise upload will be extremely slow.

## Getting started

A small cli that watches a folder and uploads every change to s3

1. Install via npm `npm install s3-auto-sync -g`

2. Usage: `s3-auto-sync -b my-bucket -d ./my-folder` (You can also just go `s3-auto-sync` auto prompt will guide you through)

If the folder is new, the cli will ask if you want to create one

## Options

```sh

-r -region  # region you're uploading to.

-d -dir     # directory to be watched

-b -bucket  # bucket name to upload to

```

---

Made by [Julian](https://jkrsp.com/).