https://github.com/runnerty/executor-s3
Runnerty module: S3 executor
https://github.com/runnerty/executor-s3
aws-s3 executor runnerty s3
Last synced: 8 months ago
JSON representation
Runnerty module: S3 executor
- Host: GitHub
- URL: https://github.com/runnerty/executor-s3
- Owner: runnerty
- License: mit
- Created: 2017-04-07T14:39:55.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2023-04-10T21:36:25.000Z (about 3 years ago)
- Last Synced: 2025-02-26T23:57:57.962Z (over 1 year ago)
- Topics: aws-s3, executor, runnerty, s3
- Language: JavaScript
- Size: 129 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Smart Processes Management
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url]
# S3 executor for [Runnerty]:
### Installation:
Through NPM
```bash
npm i @runnerty/executor-s3
```
You can also add modules to your project with [runnerty]
```bash
npx runnerty add @runnerty/executor-s3
```
This command installs the module in your project, adds example configuration in your [config.json] and creates an example plan of use.
If you have installed [runnerty] globally you can include the module with this command:
```bash
runnerty add @runnerty/executor-s3
```
### Configuration sample:
Add in [config.json]:
```json
{
"id": "s3_default",
"type": "@runnerty-executor-s3",
"apiVersion": "2006-03-01",
"accessKeyId": "ABC123",
"secretAccessKey": "ABC123",
"region": "eu-west-1",
"bucket": "my.s3bucket.com"
}
```
### Plan samples:
Add in [plan.json]:
- Upload
```json
{
"id": "s3_default",
"method": "upload",
"local_file": "/tmp/test.txt",
"remote_file": "dir_one/dir_two/test_up.txt"
}
```
- Download
```json
{
"id": "s3_default",
"method": "download",
"remote_file": "test.txt",
"local_file": "/tmp/test_down.txt"
}
```
- Delete
```json
{
"id": "s3_default",
"method": "delete",
"remote_path": "folder_test/foo.txt"
}
```
- Delete array of files
```json
{
"id": "s3_default",
"method": "delete",
"remote_path": ["folder_test/sample.txt", "folder_test/sample.zip"]
}
```
- Delete glob pattern
```json
{
"id": "s3_default",
"method": "delete",
"remote_path": "folder_test/*.txt"
}
```
[runnerty]: http://www.runnerty.io
[downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-s3.svg
[npm-url]: https://www.npmjs.com/package/@runnerty/executor-s3
[npm-image]: https://img.shields.io/npm/v/@runnerty/executor-s3.svg
[david-badge]: https://david-dm.org/runnerty/executor-s3.svg
[david-badge-url]: https://david-dm.org/runnerty/executor-s3
[config.json]: http://docs.runnerty.io/config/
[plan.json]: http://docs.runnerty.io/plan/
[runnerty-cli]: https://www.npmjs.com/package/runnerty-cli