1.0.0 • Published 6 years ago
crds-publisher v1.0.0
crds-publisher
crds-publisher
is a command line tool for publishing static assets to remote file-stores. Currently, it only supports S3 but could be easily extended to support other platforms.
Installation
Add the package to the package.json
file in your node compatible project...
$ npm install crdschurch/crds-publisher --save-dev
Usage
You can invoke the binary directly, like so...
$ ./node_modules/.bin/publisher --target=s3 --files=dist/*.js
Options
The following options are available when invoking the binary...
Options | Description | Default | Required? |
---|---|---|---|
dir | Directory containing files to be uploaded | $CRDS_PUBLISHER_DIR | Yes |
pattern | Pattern for selecting which files to upload, supports globs for recursion (e.g. **/* ) | * | No |
verbose | Verbose output | false | No |
When targeting S3, the following options are required...
Options | Description | Default | Required? |
---|---|---|---|
accessKey | IAM user's AWS Access Key | $CRDS_PUBLISHER_AWS_ACCESS_KEY | Yes |
secretKey | IAM user's AWS Secret Key | $CRDS_PUBLISHER_AWS_SECRET_KEY | Yes |
bucket | S3 Bucket | $CRDS_PUBLISHER_AWS_BUCKET | Yes |
prefix | Directory prefix within S3 bucket (e.g. javascripts ) | $CRDS_PUBLISHER_AWS_PREFIX | No |
License
This project is licensed under the 3-Clause BSD License.