summaryrefslogtreecommitdiff
path: root/.config/zsh/oh-my-zsh/plugins/transfer/README.md
diff options
context:
space:
mode:
authorPedro Pereira <pedro.hr.pereira@proton.me>2026-10-16 15:19:13 -0300
committerPedro Pereira <pedro.hr.pereira@proton.me>2026-10-16 15:19:13 -0300
commit1eb69e9a795cc19450178c07d8d382622bc7ad70 (patch)
treeb6bc60605044fe929986f31b3b6bf4fee9b56e14 /.config/zsh/oh-my-zsh/plugins/transfer/README.md
first commit
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/transfer/README.md')
-rw-r--r--.config/zsh/oh-my-zsh/plugins/transfer/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/.config/zsh/oh-my-zsh/plugins/transfer/README.md b/.config/zsh/oh-my-zsh/plugins/transfer/README.md
new file mode 100644
index 0000000..825c9a2
--- /dev/null
+++ b/.config/zsh/oh-my-zsh/plugins/transfer/README.md
@@ -0,0 +1,41 @@
+# `transfer` plugin
+
+[`transfer.sh`](https://transfer.sh) is an easy to use file sharing service from the command line
+
+To use it, add `transfer` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... transfer)
+```
+
+## Usage
+
+- Transfer a file: `transfer file.txt`.
+
+- Transfer a whole directory (it will be automatically compressed): `transfer dir`.
+
+### Encryption / Decryption
+
+- Encrypt and upload a file with symmetric cipher and create ASCII armored output:
+
+ ```zsh
+ transfer file -ca
+ ```
+
+- Encrypt and upload directory with symmetric cipher and gpg output:
+
+ ```zsh
+ transfer directory -ca
+ ```
+
+- Decrypt file:
+
+ ```zsh
+ gpg -d file -ca
+ ```
+
+- Decrypt directory:
+
+ ```zsh
+ gpg -d your_archive.tgz.gpg | tar xz
+ ```