Skip to content
The easy way to deploy websites to S3
JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
.gitignore
LICENSE
index.js
package.json
readme.md

readme.md

Mandate

Upload a directory to an S3 bucket

Command Line

Installation

npm install mandate -g

Usage

mandate <source-dir> -b <bucket-name> -k <key> -s <secret> -r <region>

Configuration

To save you typing in the command line options every time, stop accepts toml configuration files in the location .mandate.toml. An example configuration file might look like:

.mandate.toml

[aws]
bucket="example.com"
key="<AWS-KEY>"
secret="<AWS-SECRET>"
region="<AWS-REGION>"
[options]
filter=["!/node_modules", "!/.git"]

Alternatively, you can use environment variables and configure it using:

  • S3_BUCKET
  • S3_KEY
  • S3_SECRET
  • S3_REGION

API

mandate(__dirname, {
  bucket: '<bucket>',
  key: '<key>',
  secret: '<secret>',
  region: '<region>'
}, {filter: function (path) { return true }}, function (err) {
  //done
})

License

MIT

Something went wrong with that request. Please try again.