# s3-asset-upload

> S3 assets uploader. Geared towards a javascript build pipeline.

Latest version **1.2.4** (published 2019-06-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install s3-asset-upload
pnpm add s3-asset-upload
yarn add s3-asset-upload
bun add s3-asset-upload
```

Provides the command `s3-asset-upload`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2019-06-17 |
| First published | 2019-06-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Hamish Hossack |
| Maintainers | hamishhossack |
| Keywords | s3, asset, upload |

## Links

- npm: https://www.npmjs.com/package/s3-asset-upload
- npm.io page: https://npm.io/package/s3-asset-upload

## Dependencies (3)

- [throat](https://npm.io/package/throat.md) ^5.0.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.475.0
- [mime-types](https://npm.io/package/mime-types.md) ^2.1.24

## Recent versions

- 1.2.4 (latest) — 2019-06-17
- 1.2.3 — 2019-06-17
- 1.2.2 — 2019-06-17
- 1.2.1 — 2019-06-17
- 1.2.0 — 2019-06-17
- 1.1.1 — 2019-06-17
- 1.1.0 — 2019-06-14
- 1.0.0 — 2019-06-14

## README

# S3 asset upload

A simple script to batch upload your project assets to s3.

We use the environment, which is ideal for build pipelines.

## Usage

Set env
```
S3_PATH=./.nuxt/dist/client
S3_BUCKET=cdn.my-project.com
AWS_SECRET_ACCESS_KEY=AKIAIOSFODNN7EXAMPLE
AWS_ACCESS_KEY_ID=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

# Default values
S3_CACHE_CONTROL=max-age=604800,
S3_ACL=private, # change this to `public-read` if you want to serve assets directly from s3
S3_GZIP=true,
S3_IMG_TYPES=jpg,gif,png,
S3_FILE_TYPES=js,map,json,
S3_PREFIX='',
S3_IGNORE=undefined,
S3_DEBUG=false,
S3_BATCH_LIMIT=10
```

Run script on the CLI
```bash
$ yarn --global add s3-asset-upload
$ s3-asset-upload
```

Run in npm scripts
```bash
package.json
{
  "scripts": {
    "upload-assets": "s3-asset-upload"
  }
}

$ yarn upload-assets
```

---
_Source: https://npm.io/package/s3-asset-upload · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._