grunt-tentacles

A Grunt plugin for uploading files to Amazon S3.

grunt-tentacles

Upload files to Amazon S3.

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-tentacles --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-tentacles');

The "tentacles" task

Overview

In your project's Gruntfile, add a section named tentacles to the data object passed into grunt.initConfig().

grunt.initConfig({
  tentacles: {
    overview: {
      options: {
        bucketName: 'bucket.example.com'
      },
      src: ['app/index.html', 'app/styles/main.css']
    }
  },
});

Options

options.bucketName

Type: String Default value: undefined

options.accessKeyId

Type: String Default value: process.env.AWS_ACCESS_KEY_ID

options.secretAccessKey

Type: String Default value: process.env.AWS_SECRET_ACCESS_KEY

options.regions

Type: String Default value: process.env.AWS_REGIONS

Usage Examples

Default Options

Upload app/index.html, app/styles/main.css to bucket.example.com bucket.

app/index.html -> bucket.example.com/app/index.html
app/styles/main.css -> bucket.example.com/app/styles/main.css

// Required: 
// - process.env.AWS_ACCESS_KEY_ID 
// - process.env.AWS_SECRET_ACCESS_KEY 
// - process.env.AWS_REGIONS 
grunt.initConfig({
  tentacles: {
    default: {
      options: {
        bucketName: 'bucket.example.com'
      },
      src: ['app/index.html', 'app/styles/main.css']
    }
  },
});

Custom Options

Upload app/ directory to bucket.example.com bucket. ( files.cwd = app )

app/index.html -> bucket.example.com/index.html
app/.dotfile -> bucket.example.com/.dotfile

grunt.initConfig({
  tentacles: {
    custom: {
      options: {
        bucketName:      'bucket.example.com',
        accessKeyId:     process.env.MY_ACCESS_KEY_ID,
        secretAccessKey: process.env.MY_SECRET_ACCESS_KEY,
        regions:         process.env.MY_REGIONS,
      },
      files: [
        { cwd: 'app', src: '**', dot: true, filter: 'isFile' }
      ]
    }
  }
});