Versions Compared

Version Old Version 2 New Version Current
Changes made by

Matt Siebert

Matt Siebert

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
Supersede.exe Folder P:\Projects\P123\Exports\2022-02-03

The Folder command supports the search pattern option (-s or --Search

...

-Pattern):

Code Block
Supersede.exe Folder P:\Projects\P123\Exports\2022-02-03 --Search-Pattern *.pdf

Anchor
folders
folders
Folders

...

Code Block
P:\Projects\P123\Exports\2022-02-03
P:\Projects\P123\Exports\2022-02-03\DWGs

The Folders command supports the search pattern option (-s or --Search-Pattern):

Code Block
Supersede.exe Files Folders.txt --Search-Pattern *.pdf

Anchor
options
options
Options

Anchor
searchpattern
searchpattern
Search Pattern | -s or --Search-Pattern

Specifies a file search pattern for matching files to be processed in a specific folder or list of folders.

Code Block
Supersede.exe Folder P:\Projects\P123\Exports\2022-02-03 --Search-Pattern *.pdf

In the above example the search pattern will restrict the set of files processed from the specified folder to only the files that have the .pdf extension.

The search pattern can contain a combination of valid filename characters and wildcard (* and ?) characters, but it doesn't support regular expressions.

Anchor
dryrun
dryrun
Dry Run | -d or --Dry-Run

Performs a dry run showing the actions that would be performed without actually executing them.

Code Block
Supersede.exe Files Files.txt --Dry-Run

...

With dry run enabled, the utility will report that a operations have been Skipped.

Anchor
overwrite
overwrite
Overwrite | -o or --Overwrite

Instructs the Supersede utility to overwrite existing files without prompting for confirmation.

Code Block
Supersede.exe Files Files.txt --Overwrite

If the overwrite option is not enabled and an operation would cause a file to be overwritten then the utility will prompt for confirmation:

...

If the quiet option is enabled, and overwrite is not, then the operation will be skipped with a File already exists message:

...

Anchor
prompts
prompts
Prompts | -p or --Prompts

Specifies whether to display various optional confirmation prompts.

Code Block
Supersede.exe Files Files.txt --Prompts File

...

Value

Meaning

None

No additional prompts will be displayed.

File overwrite confirmation prompts will still be displayed when necessary unless the overwrite option is enabled.

This is the default value.

Execute

Displays a single confirmation prompt before any operations are performed.

This is useful in scenarios where the Supersede utility is run automatically as part of another process (for example, as a Post Processing Command) and you sometimes want to skip it.

File

Displays a confirmation prompt before processing each file.

Delete

Displays a confirmation prompt before each file delete operation.

All

Enables all optional confirmation prompts.

Values other than None can be combined, for example:

Code Block
Supersede.exe Files Files.txt --Prompts Execute,Delete

Anchor
quiet
quiet
Quiet | -q or --Quiet

Suppresses all prompts and file overwrite confirmation prompts.

Anchor
verbosity
verbosity
Verbosity | -v or --Verbosity

Specifies the verbosity of information messages.

Value

Meaning

Normal

Only information messages, warnings and errors will be displayed

Debug

Debugging messages will also be displayed

Verbose

Additional debugging messages will be displayed, and messages will be more detailed

Anchor
config
config

...

Configuration | -c, --Config or --Configuration

Specifies a folder specific configuration file to be used. The utility will ignore all other configuration sources.

Code Block
Supersede.exe Files Files.txt --Configuration D:\Test\.supersede-config

Anchor
usedefaultconfig
usedefaultconfig
Use Default Configuration | -u or --Use-Default-Configuration

Instructs the utility to use the default configuration sources (for example, any application level configuration in the global Supersede.json file (if it exists), and any relevant folder specific .supersede-config files) in addition to the configuration specified with the configuration option (--Configuration).

Code Block
Supersede.exe Files Files.txt --Configuration D:\Test\.supersede-config --Use-Default-Configuration

Anchor
help
help
Help | -?, -h or --help

...