Usage
Options
List Options
Group snapshots by source identity. Displays a separate table for each unique source lineage, making it easier to review repositories with multiple backup sources.
Global Options
- Storage backend configuration (
-storeURI, etc.) - Encryption credentials (
-password,-encryption-key, etc.) - Verbosity and machine-readable output flags (
-verbose,-quiet,-json,-debug)
Enable verbose output with additional details about snapshot loading and catalog reconciliation.
Examples
Output
The command displays a table with the following columns:Column Descriptions
- Seq: Snapshot sequence number (increments with each backup)
- Created: Timestamp when the snapshot was created (UTC)
- Snapshot Hash: Unique identifier for the snapshot (SHA-256 hash, first 16 hex chars shown)
- Source: Source type with optional volume label (e.g.
gdrive (My Drive),local (MyUSB)) - Account: Account identifier (hostname for local, email for cloud sources)
- Path: Display path within the source (portable drives are shown absolute from drive root, e.g.
/Photos) - Tags: Comma-separated tags applied to the snapshot
Snapshot hashes are displayed as short prefixes for readability. Use the full hash or short prefix with other commands like
cloudstic restore a3f8d2.Snapshot Identity
Each snapshot is associated with a source identity consisting of:- Source type (local, gdrive, onedrive, sftp)
- Identity (stable container ID)
- Path ID (stable selected-root ID within the container)
- Account (display label, e.g. hostname or email)
- Drive Name (display container label, e.g. “My Drive”, “Team Photos”)
- Path (display path)
type + identity + path_idtype + identity + path(bridge fallback)type + volume_uuid + path(legacy fallback)type + account + path(legacy fallback)
Grouped Output
Use-group to display snapshots grouped by source identity. This is useful when a repository contains backups from multiple sources:
Snapshot Catalog
Cloudstic maintains a snapshot catalog (index/snapshots) that stores lightweight summaries of all snapshots. This allows the list command to display results quickly without fetching every individual snapshot object.
The catalog automatically reconciles with the repository on load:
- Missing snapshots found via
LIST snapshot/are added to the catalog - Orphaned catalog entries (snapshot object deleted) are removed
- Self-healing ensures the catalog stays in sync
Filtering and Sorting
Thelist command displays all snapshots sorted by creation time (oldest first). For more advanced filtering and snapshot management, use:
- cloudstic forget: Remove snapshots based on retention policies with filtering by tag, source, account, or path
- cloudstic diff: Compare two snapshots to see what changed
Performance
Thelist command is fast because:
- Reads from the snapshot catalog (single object fetch)
- Does not load individual snapshot objects
- Does not traverse HAMT trees or file metadata
Empty Repository
If the repository has no snapshots yet:cloudstic backup to create your first snapshot.
Encryption
If your repository is encrypted, you must provide valid credentials:list command decrypts the catalog and individual snapshot objects as needed.
Machine-Readable Output
For scripting and automation, consider using:cloudstic cat index/snapshots: Display raw JSON snapshot catalogcloudstic cat index/latest: Display the latest snapshot referencecloudstic cat snapshot/<hash>: Display a specific snapshot’s JSON
See Also
- cloudstic ls: Browse files within a specific snapshot
- cloudstic backup: Create a new backup snapshot
- cloudstic restore: Restore files from a snapshot
- cloudstic forget: Remove snapshots based on retention policies