@alexbainter/s3-sync
Advanced tools
Transfer files to and from S3.
s3-sync deployUpload files and optionally invalidate CloudFront cache.
The name of the bucket to upload to (requires read and write access).
--bucket <bucket name>S3_SYNC_BUCKET=<bucket name>The local directory containing files to upload. Defaults to dist.
--directory <path to directory>, --dir <path to directory>S3_SYNC_DIRECTORY=<path to directory>The ID of a CloudFront distribution to invalidate.
--distributionId <distribution ID>S3_SYNC_DISTRIBUTION_ID=<distribution ID>A list of filenames whose content may change. Defaults to index.html sw.js.
--mutableFilenames <list of filenames>, --mutables <list of filenames>S3_SYNC_MUTABLE_FILENAMES=<list of filenames>A list of file extensions which should be compressed before upload. Defaults to css js html png json xml webapp ico.
--compressExtensions <list of extensions>, --compress <list of extensions>S3_SYNC_COMPRESS_EXTENSIONS=<list of extensions>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.
--aliasHtmlPages,S3_SYNC_ALIAS_HTML_PAGES=<true/false>If enabled, treats all HTML files (and aliases, if applicable) as mutable. Defaults to true.
--mutableHtml,S3_SYNC_MUTABLE_HTML=<true/false>Run command without uploading any files or invalidating a cache.
--dryRun,S3_SYNC_DRY_RUN=<true/false>s3-sync pullDownload remote files to local file system.
The name of the bucket to download from (requires read access).
--bucket <bucket name>S3_SYNC_BUCKET=<bucket name>The local directory to download files to. Defaults to dist.
--directory <path to directory>, --dir <path to directory>S3_SYNC_DIRECTORY=<path to directory>A list of filenames whose content may change. Defaults to index.html sw.js.
--mutableFilenames <list of filenames>, --mutables <list of filenames>S3_SYNC_MUTABLE_FILENAMES=<list of filenames>Run command without downloading any files.
--dryRun,S3_SYNC_DRY_RUN=<true/false>See Setting Credentials is Node.js from AWS for all authentication options.
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.
FAQs
Transfer files to and from S3
We found that @alexbainter/s3-sync demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."