Skip to main content
Create or update a named backup profile that links a source, store, and optional auth entry. Profiles save your backup configuration for reuse with cloudstic backup -profile <name>.

​
Usage

In interactive mode, you’ll be prompted for missing required fields and offered to select or create stores and auth entries. If profile new creates a new store, it now reuses the same encryption setup flow as store new (including secret reference/native secret storage prompts).

​
Options

​
string
required
Profile name. If a profile with this name already exists, its values are updated.
​
string
required
Source URI for this profile. Formats: local:<path>, sftp://[user@]host[:port]/<path>, gdrive[://<Drive>][/<path>], gdrive-changes[://<Drive>][/<path>], onedrive[://<Drive>][/<path>], onedrive-changes[://<Drive>][/<path>].
​
string
required
Name of an existing store entry to use. The store must already exist in the profiles file (or be created with -store).
​
string
Store URI. When combined with -store-ref, creates or updates the store entry with this URI.
​
string
Name of an existing auth entry. Required for cloud sources (gdrive, onedrive).
​
string
Tag to apply to snapshots created by this profile.
​
string
Exclude pattern (gitignore syntax).
​
string
Path to a file containing exclude patterns.
​
boolean
default:"false"
Skip creating a new snapshot for this profile when the resulting tree is unchanged.
​
boolean
default:"false"
Exclude Google-native files (Docs, Sheets, Slides) from backups.
​
string
Override volume UUID for local sources.
​
string
Path to Google service account credentials JSON.
​
string
Path to Google OAuth token file.
​
string
OneDrive OAuth client ID.
​
string
Path to OneDrive OAuth token file.
​
string
Path to the profiles YAML file.
​
boolean
default:"false"
Disable interactive prompts. Missing required fields cause an error.

​
Examples

​
Editing Existing Profiles

Run profile new with the same name. Existing values are preserved. Only the flags you provide are updated:

​
Interactive Mode

When running interactively without all required flags, you’ll be guided through the setup:
If you choose Create new store, Cloudstic prompts for store URI, then runs the same encryption setup workflow as store new.
  • Password/platform key options can be saved as env://... refs.
  • Native secret stores can also be selected:
    • macOS keychain://...
    • Windows wincred://...
    • Linux secret-service://...
For cloud sources, an auth entry is also required:

​
Source Validation

Source URIs are validated when creating a profile. Invalid URIs are rejected:

​
See Also