gulp-aws

A gulp plugin for interacting with the AWS cli

Showing:

Popularity

Downloads/wk

32

GitHub Stars

10

Maintenance

Last Commit

3yrs ago

Contributors

5

Package

Dependencies

3

Size (min+gzip)

14.9KB

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

gulp-aws

AWS S3 plugin for gulp. This plugin is based open AWS CLI, that supports much more features (and has better performances) then available AWS node.js libraries.

Features

  • Upload to S3

Requirements

Install

npm install gulp-aws --save-dev

API

aws.s3(bucket, options)

Upload files to AWS S3.

  • bucket: AWS bucket name

Required options

  • aws_region: AWS region
  • aws_key: AWS access key
  • aws_secret: AWS access secret

Other options

  • aws_cli_path: The path of the AWS CLI. Defaults to /usr/local/bin/aws
  • prefix_path: A path to prefix the basename of the file with when forming the S3 key

Example

Create a tar.gz with the content of the 'src' directory and upload it to S3

var aws  = require('gulp-aws');
var tar  = require('gulp-tar');
var gzip = require('gulp-gzip');

gulp.task('my-task', function() {
    return gulp.src('src/**/*', {buffer:false})
        .pipe(tar('mypackage.tar'))
        .pipe(gzip())
        .pipe(gulp.dest('./build'))
        .pipe(aws.s3('my-bucket-name', {
            aws_region: 'eu-west-1',
            aws_key:    'your aws key here',
            aws_secret: 'your aws secret here'
        }));
});

Changes

2018-10-23 - 0.1.0

  • Replaced deprecated gulp-util with plugin-error (PR #11 - thanks to chriskinsman)

Contributors

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial