Flags

Flag Short Default Help
--config-file repository.config Specify the config file to use
--[no-]help false Show context-sensitive help (also try --help-long and --help-man).
--[no-]help-full false Show help for all commands, including hidden
--password -p Repository password.
--[no-]persist-credentials true Persist credentials
--[no-]progress true Enable progress output
--[no-]use-keyring false Use Gnome Keyring for storing repository password.
--adaptive-estimation-threshold 300000 [ADV] Sets the threshold below which the classic estimation method will be used
--[no-]auto-maintenance true [ADV] Automatic maintenance
--[no-]completion-bash false [ADV] Output possible completions for the given args.
--[no-]completion-script-bash false [ADV] Generate completion script for bash.
--[no-]completion-script-zsh false [ADV] Generate completion script for ZSH.
--dangerous-commands [ADV] Enable dangerous commands that could result in data loss and repository corruption.
--diagnostics-output-directory /tmp/kopia-diagnostics [ADV] Directory where the diagnostics output should be stored saved when kopia exits. Diagnostics data includes among others: metrics, traces, profiles. The output files are stored in a sub-directory for each kopia (process) execution
--[no-]disable-repository-log false [ADV] Disable repository log
--[no-]dump-allocator-stats false [ADV] Dump allocator stats at the end of execution.
--[no-]enable-pprof false [ADV] Expose pprof handlers
--error-notifications non-interactive [ADV] Send notification on errors
--[no-]help-long false [ADV] Generate long help.
--[no-]help-man false [ADV] Generate a man page.
--initial-update-check-delay 24h [ADV] Initial delay before first time update check
--metrics-listen-addr [ADV] Expose Prometheus metrics on a given host:port
--metrics-push-addr [ADV] Address of push gateway
--metrics-push-format [ADV] Format to use for push gateway
--metrics-push-grouping [ADV] Grouping for push gateway
--metrics-push-interval 5s [ADV] Frequency of metrics push
--metrics-push-job kopia [ADV] Job ID for to push gateway
--metrics-push-password [ADV] Password for push gateway
--metrics-push-username [ADV] Username for push gateway
--[no-]metrics-store-on-exit false [ADV] Writes metrics to a file in a sub-directory of the directory specified with the --diagnostics-output-directory
--[no-]otlp-trace false [ADV] Send OpenTelemetry traces to OTLP collector using gRPC
--profile-blocking-rate [ADV] Blocking profiling rate, a value of 0 turns off block profiling
--[no-]profile-cpu false [ADV] Enable CPU profiling
--[no-]profile-go-gc-before-dump false [ADV] Perform a Go GC before writing out memory profiles
--profile-memory-rate [ADV] Memory profiling rate
--profile-mutex-fraction [ADV] Mutex profiling, a value of 0 turns off mutex profiling
--[no-]profile-store-on-exit false [ADV] Writes profiling data on exit. It writes a file per profile type (heap, goroutine, threadcreate, block, mutex) in a sub-directory in the directory specified with the --diagnostics-output-directory
--progress-estimation-type classic [ADV] Set type of estimation of the data to be snapshotted
--progress-update-interval 300ms [ADV] How often to update progress information
--timezone [ADV] Format time according to specified time zone (local, utc, original or time zone name)
--[no-]trace-storage true [ADV] Enables tracing of storage operations.
--track-releasable [ADV] Enable tracking of releasable resources.
--update-available-notify-interval 1h [ADV] Interval between update notifications
--update-check-interval 168h [ADV] Interval between update checks
--[no-]upgrade-no-block false [ADV] Do not block when repository format upgrade is in progress, instead exit with a message.
--upgrade-owner-id [ADV] Repository format upgrade owner-id.