list

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 list [--repository REPOSITORY] [--archive ARCHIVE]
                      [--path PATH] [--find PATH] [--short] [--format FORMAT]
                      [--json] [-P PREFIX] [-a PATTERN] [--sort-by KEYS]
                      [--first N] [--last N] [-e PATTERN]
                      [--exclude-from FILENAME] [--pattern PATTERN]
                      [--patterns-from FILENAME] [-h]

List the files in an archive or search for a file across archives

list arguments:
  --repository REPOSITORY
                        Path of repository containing archive to list,
                        defaults to the configured repositories, quoted globs
                        supported
  --archive ARCHIVE     Name or hash of a single archive to list (or "latest")
  --path PATH           Path or pattern to list from a single selected archive
                        (via "--archive"), can specify flag multiple times,
                        defaults to listing the entire archive
  --find PATH           Partial path or pattern to search for and list across
                        multiple archives, can specify flag multiple times
  --short               Output only path names
  --format FORMAT       Borg format for the file listing
  --json                Output results as JSON
  -P PREFIX, --prefix PREFIX
                        Deprecated. Only list archive names starting with this
                        prefix
  -a PATTERN, --match-archives PATTERN, --glob-archives PATTERN
                        Only list archive names matching this pattern
  --sort-by KEYS        Comma-separated list of sorting keys
  --first N             List first N archives after other filters are applied
  --last N              List last N archives after other filters are applied
  -e PATTERN, --exclude PATTERN
                        Exclude paths matching the pattern
  --exclude-from FILENAME
                        Exclude paths from exclude file, one per line
  --pattern PATTERN     Include or exclude paths matching a pattern
  --patterns-from FILENAME
                        Include or exclude paths matching patterns from
                        pattern file, one per line
  -h, --help            Show this help message and exit

Related documentation

• How to inspect your backups