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

Commit 80a3159

Browse files
committed
updates readme
1 parent 104d0d8 commit 80a3159

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Options are an object with following properties:
8282

8383
* `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.
8484
* `privateKey` (optional): Can be a `string` or `Buffer` that contains a private key. If not set, it fallbacks to `~/.ssh/id_rsa`
85-
* `passphrase` (optional): Is a `string` which is to decrypt the encrypted private keys. If not set, it falls back to no password.
85+
* `agentForward` (optional): Is a `boolean` which uses the `ssh-agent` for connection (defaults to `false`.
8686
* `endHost` (required): The host you want to end up on (connect to)
8787
* `bastionHost` (optional): You can specify a bastion host if you want
8888

0 commit comments

Comments
 (0)