https://github.com/paulhammond/sup

An S3 upload tool
https://github.com/paulhammond/sup

Last synced: about 1 month ago
JSON representation

An S3 upload tool

• Host: GitHub
• URL: https://github.com/paulhammond/sup
• Owner: paulhammond
• License: mit
• Created: 2022-05-06T19:01:57.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-17T18:24:09.000Z (over 2 years ago)
• Last Synced: 2024-06-19T16:27:42.729Z (5 months ago)
• Language: Go
• Homepage:
• Size: 66.4 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# sup

sup is a tool for uploading files to S3 in a repeatable manner. Like `aws s3

sync` it only uploads files that have changed. Unlike that tool it uses a

configuration file that allows you to specify per-object metadata and

transformations. It is intended for use in deployment pipelines, especially for

uploading static web content.

## Installing

Prepackaged binaries may be provided in the future. Until then:

1. [Install Go][go-install].

2. Clone the repository

3. Inside the checkout run `go generate ./... && go build ./cmd/sup`

This will generate a static executable called `sup`.

[go-install]: https://go.dev/doc/install

## Usage

Assuming you want to upload files from a directory called 'www', start by

creating  a config file:

```

echo 'source = "www"' > sup.hcl

```

Then run sup with the path to the config file and the URL of an S3 bucket:

```

sup sup.hcl s3://bucket/prefix

```

For more documentation, including all supported configuration options, run `sup --help`

## License

sup is licensed under the MIT license. For information on the licenses of all included modules run `sup --credits`.