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

@alexbainter/s3-sync

v2.0.1

Published

Transfer files to and from S3

Downloads

28

Readme

@alexbainter/s3-sync

Transfer files to and from S3.

CLI usage

s3-sync deploy

Upload files and optionally invalidate CloudFront cache.

Options

Bucket

The name of the bucket to upload to (requires read and write access).

  • CLI: --bucket <bucket name>
  • Environment variable: S3_SYNC_BUCKET=<bucket name>
Directory (optional)

The local directory containing files to upload. Defaults to dist.

  • CLI: --directory <path to directory>, --dir <path to directory>
  • Environment variable: S3_SYNC_DIRECTORY=<path to directory>
Distribution ID (optional)

The ID of a CloudFront distribution to invalidate.

  • CLI: --distributionId <distribution ID>
  • Environment variable: S3_SYNC_DISTRIBUTION_ID=<distribution ID>
Mutable filenames (optional)

A list of filenames whose content may change. Defaults to index.html sw.js.

  • CLI: --mutableFilenames <list of filenames>, --mutables <list of filenames>
  • Environment variable: S3_SYNC_MUTABLE_FILENAMES=<list of filenames>
Compress Extensions (optional)

A list of file extensions which should be compressed before upload. Defaults to css js html png json xml webapp ico.

  • CLI: --compressExtensions <list of extensions>, --compress <list of extensions>
  • Environment variable: S3_SYNC_COMPRESS_EXTENSIONS=<list of extensions>
Alias HTML Pages (optional)

If enabled, uploads a copy of any non-index HTML file without its extension. For example, uploads a copy of about.html named about. Useful for vanity URLs like example.com/about. Defaults to true.

  • CLI: --aliasHtmlPages,
  • Environment variable: S3_SYNC_ALIAS_HTML_PAGES=<true/false>
Mutable HTML (optional)

If enabled, treats all HTML files (and aliases, if applicable) as mutable. Defaults to true.

  • CLI: --mutableHtml,
  • Environment variable: S3_SYNC_MUTABLE_HTML=<true/false>
Dry Run (optional)

Run command without uploading any files or invalidating a cache.

  • CLI: --dryRun,
  • Environment variable: S3_SYNC_DRY_RUN=<true/false>

s3-sync pull

Download remote files to local file system.

Options

Bucket

The name of the bucket to download from (requires read access).

  • CLI: --bucket <bucket name>
  • Environment variable: S3_SYNC_BUCKET=<bucket name>
Directory (optional)

The local directory to download files to. Defaults to dist.

  • CLI: --directory <path to directory>, --dir <path to directory>
  • Environment variable: S3_SYNC_DIRECTORY=<path to directory>
Mutable filenames (optional)

A list of filenames whose content may change. Defaults to index.html sw.js.

  • CLI: --mutableFilenames <list of filenames>, --mutables <list of filenames>
  • Environment variable: S3_SYNC_MUTABLE_FILENAMES=<list of filenames>
Dry Run (optional)

Run command without downloading any files.

  • CLI: --dryRun,
  • Environment variable: S3_SYNC_DRY_RUN=<true/false>

AWS authentication

See Setting Credentials is Node.js from AWS for all authentication options.

Environment variables

  • AWS_ACCESS_KEY_ID=<access key id>
  • AWS_SECRET_ACCESS_KEY=<secret access key>

See Loading Credentials in Node.js from Environment Variables from AWS for more information.