Skip to content

This project enables downloading data from S3 a breeze, it has 3 modes (CLI mode, Interactive mode & Download All mode) using which you can download AWS S3 bucket files into default or custom path. If you choose the same directory as the previous time, it'll sync those changes.

License

Notifications You must be signed in to change notification settings

opendevs-org/S3-Bucket-Download

Repository files navigation

👋 Welcome to S3 Bucket Download (s3-bucket-downloader) 🕶

This project enables downloading data from s3 a breeze, it has 3 modes (CLI mode, Interactive mode & Download All mode) using which you can download aws s3 bucket files into default or custom path.
If you choose the same directory as previous time, it'll sync those changes.

It now supports setting of aws config like AWS Access key ID, AWS Secret key, AWS region & Output format in interactive mode

Install

npm i -g s3-bucket-downloader

Usage

Run anyone of following commands (only interactive mode available currently):

Interactive mode now supports setting of aws config like AWS Access key ID, Secret key, Region & Output format in interactive mode if none present in the system.

s3
# or
s3-downloader
# or
s3-bucket-downloader

Usage (advanced user)

Advanced users have to set AWS config themselves for now

Interactive mode:

node download

It'll display list of all buckets in an array & ask for options like:

Interactive mode options

CLI mode:

node download --bucketName=[comma,seperated,bucketnames] --path=[path to save to for ex: ../data]

Without brackets ofcourse.

Download All mode:

node download --all

Just downloads all of the files in all of the buckets.

Logs:

It shows logs too, like these:

Interactive mode options

🕺 Author

open devs ([email protected])

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

🚀 future scope

  1. Support for different AWS profiles & regions
  2. Add a GUI on top of this (React + Electron planned)

🤝 contributing

contributions, issues and feature requests are welcome!
feel free to check issues page. you can also take a look at the contributing guide.

🙌 show your support

give a ⭐️ if this project helped you!

Buy Me A Coffee

📝 license

copyright © 2020 open devs ([email protected]).
This project is MIT licensed.


this README was generated with ❤️ by readme-md-generator

About

This project enables downloading data from S3 a breeze, it has 3 modes (CLI mode, Interactive mode & Download All mode) using which you can download AWS S3 bucket files into default or custom path. If you choose the same directory as the previous time, it'll sync those changes.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors 4

  •  
  •  
  •  
  •