Skip to content

Command Line Parameters

Jump to bottom
James Fantin-Hardesty edited this page Sep 2, 2025 · 5 revisions

Cloudfuse supports many command-line flags. Most flags can also be set in the YAML configuration file (preferred), but a few are CLI-only or commonly provided on the CLI:

  • CLI-only / security-related:
    • --config-file=<PATH>: Path to the config file used for the mount (default: config.yaml in current dir).
    • --secure-config: Treat the config as encrypted / encrypt auto-generated config for each container.
    • --passphrase=<STRING>: Passphrase used to encrypt/decrypt secure configs. Can also be provided via environment variable CLOUDFUSE_SECURE_CONFIG_PASSPHRASE.

All other mount options listed below may be set either as CLI flags or in the configuration file.

General options (mount / global)

  • --foreground: Run mount in foreground (default: false).
  • --dry-run: Validate configuration and credentials without making changes (implies foreground).
  • --enable-remount-system: Install a remount mechanism so mounts are re-created after reboot (Windows/Service behavior).
  • --remount-system-user=<USER>: User account the remount service should run as.
  • --wait-for-mount=<duration>: Parent process will wait up to this timeout for the mount to start (default: 5s).
  • --log-level=<LOG_*>: Logging level (default: LOG_WARNING). Allowed: LOG_OFF|LOG_CRIT|LOG_ERR|LOG_WARNING|LOG_INFO|LOG_DEBUG.
  • --log-file-path=<PATH>: Path for log file (default: $HOME/.cloudfuse/cloudfuse.log).
  • --log-type=<TYPE>: Logger type (base by default). Allowed: silent|syslog|base.
  • --read-only: Mount container read-only.
  • --disable-version-check: Disable automatic version check.
  • --help, -h: Show help for a command.

Where to set options

  • Use the YAML config file for persistent configuration (preferred).
  • Use CLI flags for ad-hoc overrides or when bootstrapping encrypted configs.
  • Use environment variable CLOUDFUSE_SECURE_CONFIG_PASSPHRASE or --passphrase to provide the secure-config passphrase at runtime.

For the complete, up-to-date flag list for a given version, run:

cloudfuse mount -h

Notes

  • The cloudfuse mount command exposes the flags shown above. Notable defaults:
    • --config-file defaults to config.yaml in the working directory.
    • --wait-for-mount default is 5s.
    • Logging defaults: log-level=LOG_WARNING, log-type=base, log-file-path=$HOME/.cloudfuse/cloudfuse.log.

Clone this wiki locally