index : bitwarden-ssh-agent.git

677c906221b6431744645c6622f9b0a8e3d044bd [patch]

c9fec47aaca1bb05723222e737cc73b52028aef5

286310eb05f3279f88b6b4764f7faaa331e03314

677c906221b6431744645c6622f9b0a8e3d044bd.tar.gz

docs: add pandoc man page template

Diff

 doc/man/bw-ssh-agent.1.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 71 insertions(+)

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 \<sparkles@holly.sh>

REPOSITORY
==========

https://git.holly.sh/bitwarden-ssh-agent.git
\ No newline at end of file