--keyfile documentation is incorrect
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 16.6k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
The --keyfile expects a file containing a chiselKey (ECDSA key starting with "ck-") or the chiselKey itself as an argument.
Documentation indicated you could supplying it a base64 encoded version of chiselKey, but that's not what the code expects today at least.
Pull request: https://github.com/jpillora/chisel/pull/461
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
Review the documentation for the --keyfile option and compare it with the behavior described in pull request #461. Remove or correct the claim that a base64-encoded chiselKey is accepted; done when the documentation matches the accepted file and argument forms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100