config bootstrap

Here's the command-line help for this action in the most recent version of borgmatic. If you're using an older version, some of these flags may not work, and you should instead run the action with --help to see the flags specific to your borgmatic version.

usage: borgmatic config bootstrap --repository REPOSITORY
                                  [--local-path LOCAL_PATH]
                                  [--remote-path REMOTE_PATH]
                                  [--user-runtime-directory USER_RUNTIME_DIRECTORY]
                                  [--borgmatic-source-directory BORGMATIC_SOURCE_DIRECTORY]
                                  [--archive ARCHIVE] [--destination PATH]
                                  [--strip-components NUMBER] [--progress]
                                  [--ssh-command COMMAND] [-h]

Extract the borgmatic configuration files from a named archive

config bootstrap arguments:
  --repository REPOSITORY
                        Path of repository to extract config files from,
                        quoted globs supported
  --local-path LOCAL_PATH
                        Alternate Borg local executable. Defaults to "borg"
  --remote-path REMOTE_PATH
                        Alternate Borg remote executable. Defaults to "borg"
  --user-runtime-directory USER_RUNTIME_DIRECTORY
                        Path used for temporary runtime data like bootstrap
                        metadata. Defaults to $XDG_RUNTIME_DIR or $TMPDIR or
                        $TEMP or /var/run/$UID
  --borgmatic-source-directory BORGMATIC_SOURCE_DIRECTORY
                        Deprecated. Path formerly used for temporary runtime
                        data like bootstrap metadata. Defaults to ~/.borgmatic
  --archive ARCHIVE     Name or hash of a single archive to extract config
                        files from, defaults to "latest"
  --destination PATH    Directory to extract config files into, defaults to /
  --strip-components NUMBER
                        Number of leading path components to remove from each
                        extracted path or "all" to strip all leading path
                        components. Skip paths with fewer elements
  --progress            Display progress for each file as it is extracted
  --ssh-command COMMAND
                        Command to use instead of "ssh"
  -h, --help            Show this help message and exit

Related documentation

• Extract the configuration files used to create an archive