S3 Sync
Find a file
Paul Campbell eec79066f3
Smooth progress bar (#78)
* [domain] rewrite and expand ansi codes available

* [aws-api] refactor progress-bar

* [domain] move progress-bar into Terminal

* [aws-api] remove unused value

* [domain] use unicode characters to get a smooth progress bar
2019-06-20 22:58:21 +01:00
.github [github] Add stale configuration 2019-05-14 07:05:48 +01:00
aws-api/src/main/scala/net/kemitix/thorp/aws/api Smooth progress bar (#78) 2019-06-20 22:58:21 +01:00
aws-lib/src Smooth progress bar (#78) 2019-06-20 22:58:21 +01:00
bin Rename project to Thorp (#75) 2019-06-17 15:33:49 +01:00
cli/src Add support for per directory configuration files (#71) 2019-06-20 17:18:46 +01:00
core/src Add support for global and user configuration files (#73) 2019-06-20 17:41:08 +01:00
domain/src Smooth progress bar (#78) 2019-06-20 22:58:21 +01:00
project Enable running outside of sbt (#55) 2019-06-11 23:36:08 +01:00
.gitignore Rename project to Thorp (#75) 2019-06-17 15:33:49 +01:00
.travis.yml [travis] define AWS_REGION environment variable 2019-05-16 19:28:50 +01:00
build.sbt Add support for per directory configuration files (#71) 2019-06-20 17:18:46 +01:00
CHANGELOG.org Add support for global and user configuration files (#73) 2019-06-20 17:41:08 +01:00
LICENSE Create LICENSE 2019-06-07 21:25:23 +01:00
README.org Add support for global and user configuration files (#73) 2019-06-20 17:41:08 +01:00

thorp

Synchronisation of files with S3 using the hash of the file contents.

file:https://img.shields.io/codacy/grade/14ea6ad0825249c994a27a82d3485180.svg?style=for-the-badge

Originally based on Alex Kudlick's aws-s3-sync-by-hash.

The normal aws s3 sync ... command only uses the time stamp of files to decide what files need to be copied. This utility looks at the md5 hash of the file contents.

Usage

  thorp
  Usage: thorp [options]

    -s, --source <value>  Source directory to sync to S3
    -b, --bucket <value>  S3 bucket name
    -p, --prefix <value>  Prefix within the S3 Bucket
    -i, --include <value> Include matching paths
    -x, --exclude <value> Exclude matching paths
    -d, --debug           Enable debug logging

If you don't provide a source the current diretory will be used.

The --include and --exclude parameters can be used more than once.

Configuration

Configuration will be read from these files:

  • Global: /etc/thorp.conf
  • User: ~/.config/thorp.conf
  • Source: ${source}/.thorp.conf

Command line arguments override those in Source, which override those in User, which override those Global, which override any built-in config.

Built-in config consists of using the current working directory as the source.

Note, that include and exclude are cumulative across all configuration files.

Behaviour

When considering a local file, the following table governs what should happen:

# local file remote key hash of same key hash of other keys action
1 exists exists matches - do nothing
2 exists is missing - matches copy from other key
3 exists is missing - no matches upload
4 exists exists no match matches copy from other key
5 exists exists no match no matches upload
6 is missing exists - - delete

Executable JAR

To build as an executable jar, perform `sbt assembly`

This will create the file `cli/target/scala-2.12/thorp-assembly-$VERSION.jar` (where $VERSION is substituted)

Copy and rename this file as `thorp.jar` into the same directory as the `bin/throp` shell script.