Usage:
s3p <command> [options...]
Commands:
help # Show this help information
init # Create .s3p.config.js in CWD
ls [roots...] # List files in origin, target, and any specified roots
sync # Upload changed origin files to target
version # Display package versions
Options:
--config-path, --config # Path to config file [default: .s3p.config.js]
--cwd, -C # Current working directory [string]
--json, -j # Format output as JSON
--limit-requests, -l # Max parallel list/put/copy/delete operations [default: 3]
--origin, -o # Origin root [default: CWD]
--origin-ignore, -i # Origin ignore glob pattern [string]
--origin-ignore-path, -g # Path to origin ignore file [default: .s3p.origin.ignore]
--target, -t # Target root [string]
--target-ignore, -I # Target ignore glob pattern [string]
--target-ignore-path, -G # Path to target ignore file [default: .s3p.target.ignore]
--show-hashes, -h # Display MD5 file hashes
--show-ignored, -x # Display ignored files
init Options:
--force, -f # Overwrite config file if it exists
--write-path, --write # Path to output file
sync Options:
--change, -c # Upload non-ignored origin files even if unchanged
--delete, -d # Delete target files that do not exist in origin
--expect, -e # Only upload origin files that already exist in target
--go, -y # Preview and perform operations without prompting
--no-go, -n # Preview operations without performing them or prompting
--limit-compares, -s # Max parallel file compare operations [default: 10]
--show-params, -p # Display operation request parameters
--show-skipped, -v # Display skipped (unchanged/unexpected) files
Environment Variables:
AWS_PROFILE # AWS credentials profile used by the SDK
AWS_REGION # AWS region used by the SDK
CI=1 # Disable progress animations
DATE_FORMAT # Date format mask [default: yyyy-mm-dd HH:MM:ss]
DEBUG=1 # Show error stack traces
FORCE_COLOR=0 # Disable terminal colors
MUTE=1 # Prevent all output
PORCELAIN=1 # Show sizes in bytes, durations in ms, dates as ISO 8601
Options may be specified as command line arguments
or in a config file
.
AWS_PROFILE
Set the AWS profile used by the SDK
AWS_REGION
Set the AWS region used by the SDK
See https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-region.html
CI
Set CI=1
to disable progress animations
Not relevant when output is formatted as JSON. If configured logger stream
is not TTY, the animations are disabled automatically.
DATE_FORMAT
Date format mask (default: yyyy-mm-dd HH:MM:ss
)
DEBUG
Set DEBUG=1
to show error stack traces
FORCE_COLOR
Set FORCE_COLOR=0
to disable terminal colors
MUTE
Set MUTE=1
to completely mute output. Any Errors encountered before the config file is loaded will still be visible.
PORCELAIN
Set PORCELAIN=1
to display:
Generated using TypeDoc