# stream-upload-file-s3

> ```bash $ npm install -g stream-upload-file-s3 ```

Latest version **1.0.4** (published 2016-08-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install stream-upload-file-s3
pnpm add stream-upload-file-s3
yarn add stream-upload-file-s3
bun add stream-upload-file-s3
```

Provides the command `stream-upload-file-s3`.

## 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.0.4 |
| Published | 2016-08-18 |
| First published | 2016-08-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | alfredwesterveld |

## Links

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

## Dependencies (2)

- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.5.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0

## Recent versions

- 1.0.4 (latest) — 2016-08-18
- 1.0.3 — 2016-08-17
- 1.0.2 — 2016-08-15
- 1.0.1 — 2016-08-15
- 1.0.0 — 2016-08-15

## README

#Installing

```bash
$ npm install -g stream-upload-file-s3 
```

#Configure

config.json:

```javascript
{
  "accessKeyId": "",
  "secretAccessKey": "",
  "region": "eu-west-1",
  "bucket": ""
}
```

#Usage

**command:**

```bash
stream-upload-file-s3 -c <config> -file <file> -bucket bucket 
```

**Parameters:** 

- _config:_ location of config with json from above. Config can also be optional but then a .config should be available in current working directory
- _file:_ Required paremeter: location of file to put in bucket
- _bucket:_ To override bucket config.json


#Add alias.

If desired you could create a function(shortcut) for this in your bash_aliases for example:

```bash
s3upload () { stream-upload-file-s3 --config /Users/alfredwesterveld/.config/stream-upload-file-s3/config.json --filename "$@"; }
```

Then you can just use `s3upload #filename`

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