cli: pgp export help needs better documentation
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 9.2k
- Forks
- 1.3k
- Avg merge
- 12h 58m
- Merged PRs (30d)
- 56
Description
I have multiple keys on my account. When I ran keybase pgp export, it errored and said I needed to specify a key to export. I checked the --help docs and saw there was a --query option. However, the syntax of what a query looks like was not explained.
Thanks to https://github.com/keybase/client/issues/6548, I was able to figure it out. But I suggest updating the help text to be clearer. Something like:
--query Only export keys matching that PGP fingerprint.
- keybase version 5.5.1-20200527202541+39ca0071e5
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the CLI command implementation and help text for keybase pgp export and its --query option. Update the help text to explain that the query matches a PGP fingerprint, then run keybase pgp export --help to verify the wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, cryptography
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100