From babc7ad0c2a6a16c6720183d940ff157171954dc Mon Sep 17 00:00:00 2001
From: Steven Agyekum <burnett@posteo.de>
Date: Mon, 2 Aug 2021 19:36:36 +0200
Subject: [PATCH] mention new agent-askpass and agent-add behavior

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 6dc0be0..f6d2a30 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,11 @@ This command adds a key to the currently running SSH agent. The key is taken fro
 This command starts the SSH agent and loads the private key from the "SSH_PRIVATE_KEY" environment var. The command takes one optional argument, for the name of the agent to be started. Defaults to "default".
 As with agent-start, this command needs to be sourced.
 
+#### agent-askpass
+This command is called by ssh-add when the [SSH_ASKPASS](https://man.openbsd.org/ssh-add.1#ENVIRONMENT) variable is set active. The command returns the SSH_PASS to [ssh-askpass(1)](https://man.openbsd.org/ssh-askpass.1).
+
+This command is ignored by ssh-add if the key does not require a passphrase.
+
 ### known_hosts management
 #### hosts-clear
 This command truncates the known_hosts file and sets its permissions.
@@ -78,3 +83,11 @@ deploy:
   script:
     - rsync -zrSlhaO --chmod=D2775,F664 --delete-after . $FTP_USER@$FTP_HOST:/var/www/deployment/
 ```
+
+## Using with passphrase protected key
+
+You can supply a passphrase with ``SSH_PASS`` to ``agent-add``, ``agent-start`` or ``agent-autostart``.
+
+```
+SSH_PASS="THE_PASSPHRASE" agent-add
+```