npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

s3-directory-upload

v2.0.1

Published

upload directory to AWS S3

Downloads

13

Readme

s3 directory upload

Script to upload directory (all folders and files in it) to a S3 bucket by using official Amazon SDK.

AWS Credentials

In order to use this module, you'll need to have AWS Credentials. You can load them, two ways:

  • By passing directly to the method as second parameter.
  • By having a .env file with the credentials. The ENV variables are ACCESS_KEY_ID, SECRET_ACCESS_KEY and BUCKET_NAME.

Install

npm install s3-directory-upload -S

In case you want to use the CLI, you can install it globally:

npm install -g s3-directory-upload

Require

const upload = require('s3-directory-upload')
// ES6: import s3UploadDirectory from 's3-directory-upload'

const directoryName = 'static'

const credentials = {
  "host": "<Custom host to upload directory>", // [optional], default Amazon Host
  "accessKeyId": "<Your Access Key Id>",
  "secretAccessKey": "<Your Secret Access Key>",
  "bucketName": "<Your Bucket Name>"
}
const deleteExistingFilesInBucket = true; // default false

upload(directoryName, credentials, deleteExistingFilesInBucket)

CLI

$ s3-directory-upload <directory>

Example:
$ s3-directory-upload static

For the AWS Credentials you need a ENV variables called ACCESS_KEY_ID, SECRET_ACCESS_KEY and BUCKET_NAME in .env file.

! If you use CLI to upload files they will be added without deleting existing files in the bucket.

! CLI does not support host changing