mafintosh / mafintosh/ssh-exec
How to add the key?
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 124
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
In your example
```
exec('ls -lh', {
user: 'ubuntu',
host: 'my-remote.com',
key: myKeyFileOrBuffer,
password: 'my-user-password'
}).pipe(process.stdout)
```
what type is myKeyFileOrBuffer? is it a path to the key file?
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
Locate the documentation containing the shown exec example and inspect the key option's surrounding API guidance. Clarify the expected form of myKeyFileOrBuffer, update the example or explanatory text, and verify that the documentation answers whether a key-file path is accepted.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100