Skip to content

docs: update README #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rmanibus merged 1 commit into from
Mar 13, 2026
Merged

docs: update README #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ Or download a binary from [Releases](https://github.com/cloudstic/cli/releases).
cloudstic init

# Back up a local directory (prompts for password if not set via flag or env)
cloudstic backup -source local -source-path ~/Documents
cloudstic backup -source local:~/Documents

# Back up Google Drive (opens browser for auth on first run)
cloudstic backup -source gdrive-changes

# Back up a USB drive (auto-detected by partition UUID)
cloudstic backup -source local -source-path /Volumes/MyUSB
cloudstic backup -source local:/Volumes/MyUSB

# List snapshots
cloudstic list
Expand All @@ -63,14 +63,14 @@ cloudstic list
cloudstic restore

# Preview what a backup would do (dry run)
cloudstic backup -source local -source-path ~/Documents -dry-run
cloudstic backup -source local:~/Documents -dry-run
```

When running interactively, Cloudstic prompts for the repository password if no credential is provided via flags or environment variables. For non-interactive use (scripts, cron), pass `-encryption-password` or set `CLOUDSTIC_ENCRYPTION_PASSWORD`:
When running interactively, Cloudstic prompts for the repository password if no credential is provided via flags or environment variables. For non-interactive use (scripts, cron), pass `-password` or set `CLOUDSTIC_PASSWORD`:

```bash
cloudstic init -encryption-password "my passphrase"
cloudstic backup -source local -source-path ~/Documents -encryption-password "my passphrase"
cloudstic init -password "my passphrase"
cloudstic backup -source local:~/Documents -password "my passphrase"
```

## Portable Drive Backup
Expand All @@ -79,10 +79,10 @@ Cloudstic automatically detects when a source path is on a portable drive (USB s

```bash
# On macOS — drive mounts at /Volumes/MyUSB
cloudstic backup -source local -source-path /Volumes/MyUSB
cloudstic backup -source local:/Volumes/MyUSB

# On Linux — same drive mounts at /mnt/usb
cloudstic backup -source local -source-path /mnt/usb
cloudstic backup -source local:/mnt/usb

# Both produce identical snapshots with the same source identity
cloudstic list
Expand Down
Loading