@elmeet/ali-oss-upload-cli

ali-oss-upload-cli

Usage

1. Install package

npm install --save @elmeet/ali-oss-upload-cli

or

yarn add --dev @elmeet/ali-oss-upload-cli

2. Add an config file oss.secret.json under your project's directory.

{
  "region": "oss-cn-shanghai",
  "bucket": "demo-static",
  "accessKeyId": "xxxxxx",
  "accessKeySecret": "xxxxxx"
}

You should add this secret file to .gitignore file for preventing commit.

[Optional] the config file can also be a js module then you can read id and secret from process env.

module.exports = {
  region: 'oss-cn-shanghai',
  bucket: 'pageviver',
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET
};

3. Run upload command

# upload dist dir to remote `/collab-static`
elmeet-oss-upload dist -o /collab-static -c config/oss.secret.json

# upload to bucket root dir
elmeet-oss-upload priv/static -o / -c config/oss.secret.json

# config can be a node module
elmeet-oss-upload priv/static -o / -c config/oss.config.js

# omit `-c` if config file is in the default location: $project/oss.config.js
elmeet-oss-upload dist -o '/'

# clear remote directory before uploading
elmeet-oss-upload dist -o '/' -C

4. show help

elmeet-oss-upload -h

Usage: elmeet-oss-upload [options] <dir>

  Options:

    -V, --version        output the version number
    -o, --output <dir>   remote directory
    -C, --clear          clear remote directory before uploading
    -c, --config <file>  oss config file
    -h, --help           output usage information