scott/bitwarden-ssh-agent
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Merge pull request #23 from modem7/readme-update

Browse source 
Update README for clearer override option visibility.
This commit is contained in:
Joao Jacome 2022-04-28 10:06:23 +01:00 committed by GitHub
parent 9a6210024b 22301952b7
commit c755ee4dae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -15,10 +15,14 @@ Fetches SSH keys stored in Bitwarden vault and adds them to `ssh-agent`.
2. Enter your Bitwarden credentials, if a Bitwarden vault session is not already set. 2. Enter your Bitwarden credentials, if a Bitwarden vault session is not already set.
3. (optional) Enter your SSH keys' passphrases. 3. (optional) Enter your SSH keys' passphrases.
## Storing the keys in BitWarden ## Storing the keys in BitWarden
1. Create a folder called `ssh-agent` (can be overridden on the command line). 1. Create a folder called `ssh-agent` (can be overridden on the command line).
2. Add an new secure note to that folder. 2. Add an new secure note to that folder.
3. Upload the private key as an attachment. 3. Upload the private key as an attachment.
4. Add the custom field `private` (can be overridden on the command line), containing the file name of the private key attachment. 4. Add the custom field `private` (can be overridden on the command line), containing the file name of the private key attachment.
5. Repeat steps 2-4 for each subsequent key 5. Repeat steps 2-4 for each subsequent key
## Command line overrides
* `--debug`/`-d` - Show debug output
* `--foldername`/`-f` - Folder name to use to search for SSH keys _(default: ssh-agent)_
* `--customfield`/`-c` - Custom field name where private key filename is stored _(default: private)_