steelbrain / steelbrain/node-ssh
privateKey: Buffer.from('...')
Open
Nobody has claimed this yet.
question
- Dominant language
- TypeScript
- Stars
- 1k
- Forks
- 94
- PR merge metrics
- No merged PRs in 30d
Description
README.md shows privateKey: Buffer.from('...'), but I assume the privateKey expects only string, or not?
Would fix this typo to avoid confusion as setting Buffer in privateKey actually won't work.
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
Start with README.md and inspect the privateKey example and its surrounding wording; confirm the documented input type before editing. Done when the example no longer suggests Buffer.from(...) for privateKey and the README remains consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100