https://github.com/umbrellio/ucdn
Tool for uploading assets to AWS S3
https://github.com/umbrellio/ucdn
Last synced: about 1 year ago
JSON representation
Tool for uploading assets to AWS S3
- Host: GitHub
- URL: https://github.com/umbrellio/ucdn
- Owner: umbrellio
- Created: 2020-08-18T13:16:06.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T09:19:25.000Z (over 2 years ago)
- Last Synced: 2024-10-31T18:57:16.680Z (over 1 year ago)
- Language: JavaScript
- Size: 116 KB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ucdn
Tool for uploading assets to AWS S3.
## Installation
```sh
$ yarn global add @umbrellio/ucdn
```
or
```sh
$ npm i -g @umbrellio/ucdn
```
## Usage
### Upload
```sh
$ ucdn upload -c /path/to/config/file.yaml -C production
```
## Options
All following options except `config` and `config-key` can be configured using the config file.
Available AWS regions can be viewed at https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html.
```
--config, -c path to config file [default: "./ucdn.yml"]
--config-key, -C root config key [default: null]
--region, -r AWS geographical area [default: "eu-west-1"]
--dir, -d assets directory [default: "dist/"]
--bucket, -b AWS bucket for upload [required]
--exclude, -e excluded extenstions [default: ["html","gz"]]
--accessKeyId, --access-key-id AWS access key ID [required]
--secretAccessKey, --secret-access-key AWS secret access key [required]
--targetDir, --target-dir AWS bucket target directory [default: ""]
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/ucdn.
## License
Released under MIT License.
## Authors
Created by [Aleksei Bespalov](https://github.com/nulldef).
