summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/transfer/README.md
diff options
context:
space:
mode:
authorAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
committerAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
commitedc449275b6c04445f58b108ca0937a87c1e8430 (patch)
tree9fd484d58145b616f29a78857cc0b1c8b1c18f05 /oh-my-zsh/plugins/transfer/README.md
parent6f5424ca96c4221ef433f545642669e9c104d0ed (diff)
add zsh
Diffstat (limited to 'oh-my-zsh/plugins/transfer/README.md')
-rw-r--r--oh-my-zsh/plugins/transfer/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/transfer/README.md b/oh-my-zsh/plugins/transfer/README.md
new file mode 100644
index 0000000..825c9a2
--- /dev/null
+++ b/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
+ ```