tms restore
Restores a set of products from a snapshot file.
Synopsis
tms restore [<filename>] <-auto-register/-skip-register> [<options>] [<global-options>]
Description
Reads a snapshot file created by tms snapshot and installs the products listed in it. By default, each product is restored to the exact version recorded in the snapshot, including its pinned state. Use -latest to install the latest available version of each product instead.
You must specify either -auto-register or -skip-register to control whether restored products are registered in the IDE.
If no filename is provided, tms restore uses the filename configured as the single automatic snapshot entry in tms.config.yaml. If no such entry is configured or there is more than one, the filename argument is required.
Products without a server entry in the snapshot (local products) are skipped by default. Use -include-local to attempt to install them, though this will likely fail for products not available on any configured server.
Arguments
| Argument | Description |
|---|---|
<filename> |
Path to the snapshot file to restore from. Optional if a single automatic snapshot filename is configured in tms.config.yaml; required otherwise. |
Options
| Option | Description |
|---|---|
-auto-register |
Registers the restored products in the IDE according to the configuration. You must specify either this option or -skip-register. |
-skip-register |
Does not register the restored products in the IDE; only builds them. You must specify either this option or -auto-register. |
-latest |
Restores each product to its latest available version instead of the exact version recorded in the snapshot. |
-nobuild |
Skips the build step. Downloads product files only without compiling. |
-include:<pattern> |
Restores only products whose ID matches the given pattern. Can be specified multiple times. If omitted, all products in the snapshot are restored. |
-exclude:<pattern> |
Skips products whose ID matches the given pattern. Can be specified multiple times. |
-include-local |
Attempts to restore products that have no server entry in the snapshot (local products). This will usually fail for products not on a configured server. |
Global Options
See Global Options for options available to all commands.
Examples
Restores all products from the configured automatic snapshot file at the exact versions in the snapshot, registering them in the IDE:
tms restore -auto-register
Restores products from a specific file, skipping IDE registration, and using the latest available versions instead of the snapshot versions:
tms restore c:\backups\tms.snapshot.yaml -skip-register -latest
Restores all products except those in the tms.biz family:
tms restore -skip-register -exclude:tms.biz.* -exclude:example.test.*