@@ -21,6 +21,10 @@ Zephyrus CLI is a command-line tool that transforms your GitHub repository into
2121- 🎯 ** Stateless Mode** : Use with ` -u ` flag to authenticate without persistent sessions
2222- 🔄 ** Interactive Shell** : REPL mode for multiple commands without re-authentication
2323- 📤 ** Secure File Sharing** : Share individual files without exposing your entire vault
24+ - Generate shareable links with unique encryption keys
25+ - Share via command-line or browser-based download page
26+ - Recipients decrypt files in their browser (zero-knowledge sharing)
27+ - Complete file metadata and history in share links
2428
2529## Prerequisites
2630
@@ -150,8 +154,79 @@ If you haven't run `connect`, you can use any command with the `-u` flag to auth
150154
151155You'll be prompted for your vault password. This doesn't create a persistent session.
152156
157+ ## Secure File Sharing
158+
159+ Zephyrus makes it easy to securely share individual files with others without exposing your entire vault.
160+
161+ ### How It Works
162+
163+ 1 . ** Generate a Share Link** : Create a unique, encrypted share link for any file
164+ 2 . ** Each file gets its own encryption key** : Recipients use a separate password to decrypt
165+ 3 . ** Browser-based decryption** : Files are decrypted in the recipient's browser (zero-knowledge)
166+ 4 . ** No vault access needed** : Recipients don't need a Zephyrus account or access to your vault
167+
168+ ### Share a File
169+
170+ ``` bash
171+ # Enter interactive mode and share
172+ zep> share documents/report.pdf
173+ Enter Share Password (recipients will use this to decrypt): mysharepass123
174+
175+ ✔ File shared successfully!
176+ Filename: report.pdf
177+
178+ Share this string with recipient:
179+ Auchrio:72cTWg:mysharepass123:cmVwb3J0LnBkZg==
180+
181+ Web Share Link:
182+ https://zephyrus-development.github.io/shared/# Auchrio:72cTWg:mysharepass123:cmVwb3J0LnBkZg==
183+
184+ Recipient can download with:
185+ zep download _ output.file --shared " Auchrio:72cTWg:mysharepass123:cmVwb3J0LnBkZg=="
186+
187+ Or read with:
188+ zep read _ --shared " Auchrio:72cTWg:mysharepass123:cmVwb3J0LnBkZg=="
189+ ```
190+
191+ ### Recipient Options
192+
193+ Recipients can access shared files in 3 ways:
194+
195+ 1 . ** Web Browser** (Easiest): Click the share link and download securely in browser
196+ ```
197+ https://zephyrus-development.github.io/shared/#Auchrio:72cTWg:mysharepass123:cmVwb3J0LnBkZg==
198+ ```
199+
200+ 2 . ** CLI Download** : Use the Zephyrus CLI to download
201+ ``` bash
202+ zep download _ output.pdf --shared " Auchrio:72cTWg:mysharepass123:cmVwb3J0LnBkZg=="
203+ ```
204+
205+ 3 . ** CLI Read** : Display file content directly (no save)
206+ ``` bash
207+ zep read _ --shared " Auchrio:72cTWg:mysharepass123:cmVwb3J0LnBkZg=="
208+ ```
209+
210+ ### Manage Shared Files
211+
212+ View all shared files and their metadata:
213+ ``` bash
214+ zep shared ls
215+ ```
216+
217+ Get detailed info and regenerate share link:
218+ ``` bash
219+ zep shared info 72cTWg
220+ ```
221+
222+ Revoke a share (stop allowing access):
223+ ``` bash
224+ zep shared rm 72cTWg
225+ ```
226+
153227## Command Reference
154228
229+
155230### ` setup ` - Initialize Your Vault
156231
157232Sets up a new Zephyrus vault by encrypting and storing your GitHub SSH key.
0 commit comments