What does "per-run capacity" mean?

Each plan defines the maximum total size of source data that can be included in a single sync run. For example, if you have a 10 TB plan, you can migrate any bucket up to 10 TB in one run. If your bucket is 3 TB, the entire 3 TB is included in the plan. The limit resets for every new run.

Does the limit reset every run?

Yes. The capacity limit applies per run and is not cumulative. If you have a 10 TB plan, you can run unlimited migrations of up to 10 TB each — including retries and resumes.

Can I run multiple migrations at the same time?

Yes. You can run multiple migrations concurrently. Each run simply needs to fit within your plan's per-run capacity.

How is the run size calculated?

The total size is calculated from all discovered source objects during the planning phase. Objects are counted based on their source size, even if they already exist at the destination.

What happens if my bucket exceeds my plan's capacity?

During planning, files are scheduled until the next file would exceed your plan’s capacity. That file and all subsequent files are excluded from the run. You can then upgrade your plan or split the migration into smaller runs.

Can I upgrade my plan?

Yes. You can purchase a higher-capacity license at any time.

What’s the difference between the Free plan and the 50 GB trial?

The Free plan includes a permanent 10 GB per-run capacity with no expiration. The 50 GB trial is a 30-day license available after registration, allowing you to evaluate larger migrations before purchasing.

Does retrying or resuming a migration consume extra capacity?

No. Each run is evaluated independently. As long as the total source size fits within your plan’s per-run capacity, you can retry or resume without penalty.

Do you charge for bandwidth or transferred bytes?

No. Godwit Sync is licensed based on per-run capacity, not on transferred bandwidth.

What S3-compatible providers are supported?

Godwit Sync works with any S3-compatible storage, including AWS S3, MinIO, Cloudflare R2, Backblaze B2, DigitalOcean Spaces, Wasabi, and self-hosted object storage.

Do I need a license for --plan-only mode?

Yes. Capacity is evaluated during the planning phase. The same per-run limit applies whether you run --plan-only or execute the migration.

Is my data processed through your servers?

No. Godwit Sync runs locally in your environment. Data flows directly between source and destination. Nothing passes through our infrastructure.

Does the license work offline?

Yes. The license is a signed file that is validated locally and does not require continuous internet access.

What payment methods do you accept?

We accept all major credit and debit cards via Stripe.

Config File Reference

Configuration File Reference

Godwit Sync supports YAML configuration files as an alternative to CLI flags. Use --config (-f) to load a config file.

Basic Usage

godwit sync --config my-sync.yml
godwit sync -f my-sync.yml

# Override a config value with a CLI flag
godwit sync -f my-sync.yml --parallel 8

CLI Precedence

CLI flags always take precedence over config file values. If a flag is set on the command line, the corresponding config value is ignored.

Config File Structure

The configuration file uses YAML format with these top-level sections:

Source

Configure the source endpoint — local path or S3 bucket.

YAML Key	Type	CLI Flag	Description
source.url	string	--source	Source path or S3 URI (s3://bucket/prefix)
source.endpoint	string	--source-endpoint	S3 API endpoint (host:port)
source.access_key	string	--source-access-key	S3 access key
source.secret_key	string	--source-secret-key	S3 secret key
source.session_token	string	--source-session-token	Optional session token for temporary credentials
source.region	string	--source-region	S3 region
source.secure	bool	--source-secure	Use TLS for S3 connections
source.disable_keepalive	bool	--source-disable-keepalive	Disable HTTP keep-alive

Destination

Configure the destination endpoint — local path or S3 bucket.

YAML Key	Type	CLI Flag	Description
destination.url	string	--destination	Destination path or S3 URI
destination.endpoint	string	--destination-endpoint	S3 API endpoint (host:port)
destination.access_key	string	--destination-access-key	S3 access key
destination.secret_key	string	--destination-secret-key	S3 secret key
destination.session_token	string	--destination-session-token	Optional session token for temporary credentials
destination.region	string	--destination-region	S3 region
destination.secure	bool	--destination-secure	Use TLS for S3 connections
destination.disable_keepalive	bool	--destination-disable-keepalive	Disable HTTP keep-alive

Policy

Comparison and skip policies for object filtering.

YAML Key	Type	CLI Flag	Description
policy.compare	string	--compare-policy	Comparison policy (size,etag or size,mtime)
policy.skip	string[]	--skip	List of suffixes or patterns to skip

Options

Transfer behavior settings — parallelism, retries, overrides.

YAML Key	Type	CLI Flag	Description
options.parallel	int	--parallel	Number of parallel sync workers
options.plan_parallel	int	--plan-parallel	Number of parallel planning workers
options.buffer_multiplier	int	--buffer-multiplier	Multiplier for the copy queue length
options.multipart_threshold	int64	--multipart-threshold	Multipart upload threshold in bytes
options.override	bool	--override	Overwrite existing destination objects
options.skip_tags	bool	--skip-tags	Skip reading object tags from source
options.retry	int	--retry	Maximum retries per object
options.retry_backoff	string	--retry-backoff	Base delay between retries

Run

Run tracking — run ID, state driver and state file path.

YAML Key	Type	CLI Flag	Description
run.run_id	string	--run-id	Run identifier for tracking
run.state_driver	string	--state-driver	State backend driver
run.state_path	string	--state-path	Path to state database file
run.logs_dir	string	--logs-dir	Directory for observability logs

Output

Console output mode — UI, brief, or silent.

YAML Key	Type	CLI Flag	Description
output.ui	bool	--ui	Enable verbose console logging
output.brief	bool	--brief	Show only essential progress messages
output.silent	bool	--silent	Suppress all console output

License

License file path or inline license string.

YAML Key	Type	CLI Flag	Description
license.file	string	--license-file	Path to license file
license.inline	string	--license	Inline base64 license string

Rate Limit

Throttling controls — RPS, bandwidth, and concurrency.

YAML Key	Type	CLI Flag	Description
rate_limit.rps	float64	--rps	Requests per second limit (0 = disabled)
rate_limit.read_bps	int64	--read-bps	Read bytes per second limit (0 = disabled)
rate_limit.max_inflight	int	--max-inflight	Max concurrent uploads (0 = disabled)

Status

HTTP server address for metrics and status endpoint.

YAML Key	Type	CLI Flag	Description
status.addr	string	--status-addr	HTTP address for status/metrics server

Sample Configurations

Local Filesystem → S3

Upload a local directory to an S3-compatible bucket.

source:
  url: "./data"

destination:
  url: "s3://my-bucket/backup"
  endpoint: localhost:9001
  access_key: access_key
  secret_key: secret_key
  secure: false

options:
  parallel: 3

output:
  ui: true

status:
  addr: ":8080"

S3 → Local Filesystem

Download objects from an S3 bucket to a local directory.

source:
  url: "s3://my-bucket/data"
  endpoint: localhost:9001
  access_key: access_key
  secret_key: secret_key
  secure: false

destination:
  url: "./downloads"

policy:
  skip:
    - .md5

options:
  parallel: 6

output:
  ui: true

S3 → S3

Copy data between two S3-compatible endpoints.

source:
  url: "s3://source-bucket/data"
  endpoint: localhost:9001
  access_key: access_key
  secret_key: secret_key
  secure: false

destination:
  url: "s3://dest-bucket/backup"
  endpoint: localhost:9101
  access_key: access_key
  secret_key: secret_key
  secure: false

policy:
  skip:
    - .md5

options:
  parallel: 9

output:
  ui: true

status:
  addr: ":8080"

Full Example (All Sections)

A complete configuration file showing every available option.

source:
  url: "s3://source-bucket/prefix"
  endpoint: source.storage.example.com
  access_key: SOURCE_ACCESS_KEY
  secret_key: SOURCE_SECRET_KEY
  region: us-east-1
  secure: true

destination:
  url: "s3://dest-bucket/backup"
  endpoint: localhost:9000
  access_key: access_key
  secret_key: secret_key
  secure: false

policy:
  compare: "size,etag"
  skip:
    - .md5
    - .tmp

options:
  parallel: 4
  plan_parallel: 8
  buffer_multiplier: 4
  multipart_threshold: 67108864
  override: false
  skip_tags: false
  retry: 3
  retry_backoff: "1s"

run:
  run_id: "daily-backup"
  state_driver: sqlite
  state_path: "./godwit-sync.state.db"
  logs_dir: "./logs"

output:
  ui: true
  brief: false
  silent: false

license:
  file: "./license.json"

rate_limit:
  rps: 50
  read_bps: 104857600
  max_inflight: 10

status:
  addr: ":8080"

CLI-Only Flags

These flags have no config file equivalent and must be passed on the command line:

--config (-f) — Selects which config file to load
--plan-only — Plan transfer without copying data
--resume — Resume a previously planned transfer
--register — Register a license to disk

CLI Reference

See the complete list of all CLI flags with types, defaults, and descriptions.

View CLI Reference

← Guides CLI Reference →