Skip to content
This repository was archived by the owner on Aug 26, 2025. It is now read-only.

Commit d9489d7

Browse files
authored
More features documented!
forgot to add this to the readme
1 parent 5a83983 commit d9489d7

1 file changed

Lines changed: 1 addition & 2 deletions

File tree

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ await sshConnection.executeCommand('uptime')
8686
Options are an object with following properties:
8787

8888
* `username` (optional): The username used for your ssh connection (equivalent to `-l` option). If not set, it first looks for an `SSH_USERNAME` environment variable. If that is not set, it fallbacks to `USER` environment variable.
89+
* `password` (optional): Provide a password to authenticate with username and password, not private key. Also see `skipAutoPrivateKey`.
8990
* `privateKey` (optional): Can be a `string` or `Buffer` that contains a private key. If not set, it fallbacks to `~/.ssh/id_rsa`
9091
* `skipAutoPrivateKey` (optional): Don't try and read `~/.ssh/id_rsa` if no private key is provided
9192
* `agentForward` (optional): Is a `boolean` which uses the `ssh-agent` for connection (defaults to `false`). If set defaults to the value of env.SSH_AUTH_SOCK (all platforms), then `pageant` [on Windows](https://github.com/mscdex/ssh2#client-methods) if no SSH_AUTH_SOCK is present.
@@ -124,8 +125,6 @@ Closes all connections.
124125
* Run the test with `./test/test.sh`
125126

126127
## Limitations/Todos
127-
128-
* only works with username , private key and ssh agent
129128
* host based authentication
130129
* Better documentation
131130
* Debug logging

0 commit comments

Comments
 (0)