cloudstic profile new - Cloudstic CLI

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

cloudstic profile new [options]

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

-name

string

required

Profile name. If a profile with this name already exists, its values are updated.

-source

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>].

-store-ref

string

required

Name of an existing store entry to use. The store must already exist in the profiles file (or be created with -store).

-store

string

Store URI. When combined with -store-ref, creates or updates the store entry with this URI.

-auth-ref

string

Name of an existing auth entry. Required for cloud sources (gdrive, onedrive).

-tag

string

Tag to apply to snapshots created by this profile.

-exclude

string

Exclude pattern (gitignore syntax).

-exclude-file

string

Path to a file containing exclude patterns.

-ignore-empty-snapshot

boolean

default:"false"

Skip creating a new snapshot for this profile when the resulting tree is unchanged.

-skip-native-files

boolean

default:"false"

Exclude Google-native files (Docs, Sheets, Slides) from backups.

-volume-uuid

string

Override volume UUID for local sources.

-google-credentials

string

Path to Google service account credentials JSON.

-google-token-file

string

Path to Google OAuth token file.

-onedrive-client-id

string

OneDrive OAuth client ID.

-onedrive-token-file

string

Path to OneDrive OAuth token file.

-profiles-file

string

Path to the profiles YAML file.

--no-prompt

boolean

default:"false"

Disable interactive prompts. Missing required fields cause an error.

Examples

cloudstic profile new \
  -name documents \
  -source local:~/Documents \
  -store-ref prod-s3

cloudstic profile new \
  -name gdrive \
  -source gdrive-changes \
  -store-ref prod-s3 \
  -auth-ref google-main

cloudstic profile new \
  -name project \
  -source local:~/project \
  -store-ref prod-s3 \
  -tag production \
  -exclude "node_modules/" \
  -exclude ".git/" \
  -exclude-file .cloudsticignore \
  -ignore-empty-snapshot

cloudstic profile new \
  -name documents \
  -source local:~/Documents \
  -store-ref my-store \
  -store s3:my-bucket/backups

Editing Existing Profiles

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

# Original profile
cloudstic profile new -name docs -source local:~/Documents -store-ref prod-s3

# Later, add an exclusion (source and store-ref are preserved)
cloudstic profile new -name docs -exclude "*.log"

Interactive Mode

When running interactively without all required flags, you’ll be guided through the setup:

Profile name: documents
Source URI: local:~/Documents
Select a store
  1) Create new store
  2) prod-s3
  3) local-backup
Select option number [1]: 2
Profile "documents" saved in ~/.config/cloudstic/profiles.yaml

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 URI: gdrive-changes
Select google auth entry
  1) Create new auth
  2) google-main
Select option number [1]: 2

Source Validation

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

$ cloudstic profile new -name test -source invalid -store-ref x
unknown source "invalid": supported values are local:<path>, ...

​Usage

​Options

​Examples

​Editing Existing Profiles

​Interactive Mode

​Source Validation

​See Also

Usage

Options

Examples

Editing Existing Profiles

Interactive Mode

Source Validation

See Also