summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/rbw/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'oh-my-zsh/plugins/rbw/README.md')
-rw-r--r--oh-my-zsh/plugins/rbw/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/rbw/README.md b/oh-my-zsh/plugins/rbw/README.md
new file mode 100644
index 0000000..cae36ce
--- /dev/null
+++ b/oh-my-zsh/plugins/rbw/README.md
@@ -0,0 +1,22 @@
+# Bitwarden (unofficial) CLI plugin
+
+This plugin adds completion for [rbw](https://github.com/doy/rbw), an unofficial
+CLI for [Bitwarden](https://bitwarden.com).
+
+To use it, add `rbw` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... rbw)
+```
+
+## `rbwpw`
+
+The `rbwpw` function is a wrapper around `rbw`. It copies the password in the
+clipboard for the service you ask for and clears the clipboard 20s later.
+The usage is as follows:
+
+```zsh
+rbwpw <service>
+```
+
+This plugin does not add any aliases.