Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pmtiles upload --help #194

Open
zstadler opened this issue Nov 25, 2024 · 3 comments
Open

Update pmtiles upload --help #194

zstadler opened this issue Nov 25, 2024 · 3 comments

Comments

@zstadler
Copy link
Contributor

pmtiles upload --help has <key> as the second parameter, yet it seems that this is the remote name, as the docs say.

The help text is:

Usage: pmtiles upload --bucket=STRING <input> <key>

Upload a local archive to remote storage.

Arguments:
  <input>
  <key>

Flags:
  -h, --help                 Show context-sensitive help.

      --max-concurrency=2    # of upload threads
      --bucket=STRING        Bucket to upload to.

Perhaps the help could use the term <remote> instead of <key>.

@bdon
Copy link
Member

bdon commented Nov 25, 2024

It is the name of the key in the remote target bucket, maybe remote_key?

@zstadler
Copy link
Contributor Author

I find the word "key" confusing, especially given the need to set the access and secret access keys.

IMO, the docs are much more clear, as the use the terms "INPUT" and "REMOTE":

upload

Upload an archive to cloud storage.

# requires environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY credentials
pmtiles upload INPUT.pmtiles REMOTE.pmtiles --bucket=s3://BUCKET_NAME

@bdon
Copy link
Member

bdon commented Nov 25, 2024

Good point, I didn't think of that conflict between the access key and the object key. what about object_name?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants