From 677c906221b6431744645c6622f9b0a8e3d044bd Mon Sep 17 00:00:00 2001 From: holly sparkles Date: Sat, 23 Dec 2023 21:49:04 +0100 Subject: [PATCH] docs: add pandoc man page template --- doc/man/bw-ssh-agent.1.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 doc/man/bw-ssh-agent.1.md diff --git a/doc/man/bw-ssh-agent.1.md b/doc/man/bw-ssh-agent.1.md new file mode 100644 index 0000000..1530215 --- /dev/null +++ b/doc/man/bw-ssh-agent.1.md @@ -0,0 +1,71 @@ +% BW-SSH-AGENT(1) version 0.1.0 | User Commands +% +% 23 December 2023 + +NAME +==== + +bw-ssh-agent - add ssh keys using `bitwarden-cli` + +SYNOPSIS +======== + +| **bw-ssh-agent** \[_OPTIONS_] + +DESCRIPTION +=========== + +Add SSH keys to ssh-agent using bitwarden-cli. Written in Rust. + +OPTIONS +======= + +**-d**, **\--debug** + +: Show debug messages + +**-f** _folder_, **\--folder** _folder_ + +: The folder name within the Bitwarden vault containing SSH key passwords. + Default: ssh-agent + +**-k** _name_, **\--key** _name_ + +: The name of the custom field containing the private key filename. + Default: private + +**-p** _pass_, **\--passphrase** _pass_ + +: The name of the custom field containing the passphrase to the private key. + Default: passphrase + +**-s** _session_, **\--session** _session_ + +: The session to use to login to `bitwarden-cli`. + +EXAMPLES +======== + +``` +$ # login with session +$ bw-ssh-agent --session s8JKmKLSW9eTYaFnL5Qa+hPtdhM2xT2WWT3AsrYm2JfBG5aJgUVE2awYmZYjyZzyrJgVPeWrwWVEeKdrXKVCQLErJf8xjG/g== +$ +$ # login with session using an environment variable +$ export BW_SESSION="s8JKmKLSW9eTYaFnL5Qa+hPtdhM2xT2WWT3AsrYm2JfBG5aJgUVE2awYmZYjyZzyrJgVPeWrwWVEeKdrXKVCQLErJf8xjG/g==" +$ bw-ssh-agent +``` + +BUGS +==== + +Bugs can be submitted via e-mail. + +AUTHORS +======= + +holly sparkles \ + +REPOSITORY +========== + +https://git.holly.sh/bitwarden-ssh-agent.git \ No newline at end of file -- libgit2 1.7.2