Skip to content

Commit 2f37d20

Browse files
Nishant GauravNishant Gaurav
authored andcommitted
docs: update README to document directory and symlink support
Added documentation for new add command features: - Directory support with recursive processing - Symlink handling (files and directories) - Updated examples showing directory and symlink usage - Added detailed explanation of directory/symlink behavior
1 parent 0ac8879 commit 2f37d20

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,22 @@ sietch init --name dune --key-type aes # AES-256-GCM encryption
3333
sietch init --name dune --key-type chacha20 # ChaCha20-Poly1305 encryption
3434
```
3535

36-
**Add files**
36+
**Add files, directories, and symlinks**
3737
```bash
3838
# Single file
3939
sietch add ./secrets/thumper-plans.pdf documents/
4040

41+
# Entire directory (recursive)
42+
sietch add ~/photos vault/photos/
43+
4144
# Multiple files with individual destinations
4245
sietch add file1.txt dest1/ file2.txt dest2/
4346

44-
# Multiple files to single destination
45-
sietch add ~/photos/img1.jpg ~/photos/img2.jpg vault/photos/
47+
# Multiple sources to single destination
48+
sietch add ~/photos/img1.jpg ~/docs/ vault/backup/
49+
50+
# Symlinks (follows and adds target content)
51+
sietch add ~/link-to-file.txt vault/files/
4652
```
4753

4854
**Sync over LAN**
@@ -63,6 +69,8 @@ sietch get thumper-plans.pdf ./retrieved/
6369
| -------------------- | --------------------------------------------------------------------- |
6470
| **AES256/GPG** | Files are chunked and encrypted with strong symmetric/asymmetric keys |
6571
| **ChaCha20** | Modern authenticated encryption with ChaCha20-Poly1305 AEAD |
72+
| **Directory Support**| Recursively add entire directories while preserving structure |
73+
| **Symlink Handling** | Automatically follows symlinks and stores target content |
6674
| **Offline Sync** | Rsync-style syncing over TCP or LibP2P |
6775
| **Gossip Discovery** | Lightweight peer discovery protocol for LAN environments |
6876
| **CLI First UX** | Fast, minimal CLI to manage vaults and syncs |
@@ -73,6 +81,13 @@ sietch get thumper-plans.pdf ./retrieved/
7381
* Files are split into configurable chunks (default: 4MB)
7482
* Identical chunks across files are deduplicated to save space
7583

84+
### Directory & Symlink Handling
85+
* **Directories**: Recursively processes all files while preserving directory structure
86+
* **Symlinks to files**: Follows the symlink and stores the target file content
87+
* **Symlinks to directories**: Recursively processes all files in the target directory
88+
* **Hidden files**: Included automatically (files starting with `.`)
89+
* **Nested structures**: Full directory hierarchy is maintained in the vault
90+
7691
### Encryption
7792
Each chunk is encrypted before storage using:
7893
* **Symmetric**: AES-256-GCM or ChaCha20-Poly1305 with passphrase

0 commit comments

Comments
 (0)