Skip to content

Commit c2d8f12

Browse files
arimxyerclaude
andcommitted
docs: Update FAQ with sync features and troubleshooting
- Updated sync question with built-in rclone sync options - Clarified cloud data question (optional encrypted sync) - Added sync recovery to vault loss question - Updated security answer for local-first with optional sync - Added new FAQs for sync status check and troubleshooting 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 5409f0d commit c2d8f12

1 file changed

Lines changed: 65 additions & 19 deletions

File tree

docs/04-troubleshooting/faq.md

Lines changed: 65 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,26 @@ For automated backups, you can use cron with the backup command or copy the vaul
3838

3939
**Q: Can I sync my vault across machines?**
4040

41-
A: Yes, but carefully:
42-
```bash
43-
# Option 1: Symlink to cloud storage
44-
ln -s ~/Dropbox/vault.enc ~/.pass-cli/vault.enc
41+
A: Yes! Pass-CLI has built-in cloud sync via rclone:
4542

46-
# Option 2: Configure vault_path to point to cloud storage
47-
echo "vault_path: ~/Dropbox/vault.enc" > ~/.pass-cli/config.yml
43+
```bash
44+
# Option 1: Enable sync on existing vault
45+
pass-cli sync enable
46+
# Follow prompts to configure remote (e.g., gdrive:.pass-cli)
4847

49-
# Option 3: Manual copy (requires keeping in sync)
50-
cp ~/.pass-cli/vault.enc ~/Dropbox/vault.enc
48+
# Option 2: Connect to existing synced vault on new device
49+
pass-cli init
50+
# Select "Connect to existing synced vault" when prompted
5151

52-
# Warning: Conflicts if editing on multiple machines simultaneously
52+
# Option 3: Set up sync during new vault creation
53+
pass-cli init
54+
# Select "Create new vault", then enable sync when prompted
5355
```
5456

57+
Sync automatically pulls on first use and pushes after write operations. See [Sync Guide](../02-guides/sync-guide.md) for full details.
58+
59+
**Note**: Requires [rclone](https://rclone.org) installed and configured with at least one remote.
60+
5561
---
5662

5763
**Q: How do I change my master password?**
@@ -82,20 +88,23 @@ You'll be prompted to enter 6 words from your 24-word recovery phrase to verify
8288

8389
**Q: Is my data sent to the cloud?**
8490

85-
A: No. Pass-CLI:
86-
- [OK] Works completely offline
87-
- [OK] Never makes network calls
88-
- [OK] Stores everything locally
89-
- [OK] No telemetry or tracking
91+
A: By default, no. Pass-CLI:
92+
- ✅ Works completely offline by default
93+
- ✅ Stores everything locally
94+
- ✅ No telemetry or tracking
95+
- ✅ Optional cloud sync (you control if/when enabled)
96+
97+
If you enable cloud sync, your **encrypted** vault is synced to your configured rclone remote. Your master password and decrypted credentials never leave your device.
9098

9199
---
92100

93101
**Q: What happens if I lose my vault file?**
94102

95103
A:
96-
- If you have backup: Restore from backup
97-
- If no backup: All credentials lost, must start over
98-
- Prevention: Regular backups essential
104+
- **If sync enabled**: Run `pass-cli init` and connect to your synced vault
105+
- **If you have backup**: Restore with `pass-cli vault backup restore`
106+
- **If no backup or sync**: All credentials lost, must start over
107+
- **Prevention**: Enable cloud sync or create regular backups
99108

100109
---
101110

@@ -121,9 +130,9 @@ pass-cli list --format json | jq '.[] | .service'
121130

122131
A: See [Security Architecture](../03-reference/security-architecture) for full details:
123132
- AES-256-GCM encryption
124-
- PBKDF2 key derivation (600,000 iterations as of January 2025)
133+
- PBKDF2 key derivation (600,000 iterations)
125134
- System keychain integration
126-
- No cloud dependencies
135+
- Local-first with optional encrypted cloud sync
127136
- Limitations explained in security doc
128137

129138
---
@@ -148,3 +157,40 @@ A: Individual credentials cannot be recovered:
148157

149158
---
150159

160+
**Q: How do I check if sync is working?**
161+
162+
A: Use the doctor command:
163+
```bash
164+
pass-cli doctor
165+
```
166+
167+
This shows sync status including:
168+
- Whether sync is enabled
169+
- rclone installation status
170+
- Remote configuration
171+
- Any connectivity issues
172+
173+
---
174+
175+
**Q: Sync failed - what should I do?**
176+
177+
A: Sync failures are non-blocking (your local vault still works). To troubleshoot:
178+
179+
```bash
180+
# Check sync configuration
181+
pass-cli doctor
182+
183+
# Verify rclone can reach your remote
184+
rclone lsd your-remote:.pass-cli
185+
186+
# Check rclone config
187+
rclone config
188+
189+
# Manual sync (if needed)
190+
rclone sync ~/.pass-cli your-remote:.pass-cli
191+
```
192+
193+
See [Sync Troubleshooting](../02-guides/sync-guide.md#troubleshooting) for more details.
194+
195+
---
196+

0 commit comments

Comments
 (0)