User GuidesAPI ReferenceRelease Notes
Doc HomeHelp CenterLog In

Command Reference

This page lists the contents of the help for the administration utlity,

To view the list of parameters supported by, change to the directory <tamr-home-directory>/tamr/utils and run: config:get --help config:set --help config:reset --help upgrade --help auxiliary:install --help maintenance --help

The --help flag returns a list of supported parameters for these commands, as follows.


Use the config:get module to obtain a list of all configuration variables used by Tamr Core and their values. For more information, see Configuring Tamr Core.


config:get [--userDefined] [-h] [--help] [--help] [name]...


  • name Returns individual values for the specified individual variables. You must know their names and separate them by spaces. The format is as follows: config:get [name1 name2 name3...]. For example, you can run: config:get TAMR_LICENSE_KEY TAMR_TOTAL_CORES. Omitting this parameter will return all variables and their values.
  • userDefined Returns a list of all user-defined (overridden) configuration variables that Tamr Core uses.
  • -h, --help Provides help for this command (this information).


Use the config:set to provide configuration values for Tamr Core. You can set individual configuration property key value pairs, or set the values in bulk using a YAML file.


config:set [--dry-run] [--file <file>] [-h] [--help] [--skip-validation] (name=value)...


  • --dry-run Performs a dry run of the changes, prompting you whether to proceed before committing.
  • --file <file> Sets configuration values for Tamr Core in bulk using a YAML file that you create. The file can have multiple configuration parameters in the format: name: value, each listed on a separate line. If you use this option, the command ignores individual key/value pairs if you specify them as command line arguments.
  • name=value Sets individual values, for example: config:set <NAME>=<VALUE>.
  • --skip-validation Skips validation of the new values when loading property definitions or setting values. Warnings are provided.
  • -h, --help Provides help for this command (this information).


Use the config:reset module to reset all user-defined configuration values to their defaults.


config:reset [-h] [--help][--skip-validation] [name]...


  • name Resets individually-specified configuration properties to their defaults. Specify individual variables and separate them by spaces. For example: config:reset TAMR_LICENSE_KEY TAMR_TOTAL_CORES.
  • --skip-validation Skips validation of the reset values or values that depend on them.


Use the upgrade to specify the ZIP file and a different directory for unzipping it. For more information, see Upgrading.


upgrade (--installDir <path>) (--tempZipDir <path>) [-h] [--help]


  • --installDir Specifies the location of your current installation. For example: upgrade --installDir </path/to/install/dir> --zipFile </path/to/file>.
  • --zipFile Specifies a ZIP file for upgrades. For example: upgrade --installDir </path/to/install/dir> --zipFile </path/to/file>.
  • --upgradeDir Instead of specifying a ZIP file, you can specify a directory to upgrade from. For example: upgrade --installDir </path/to/install/dir> --upgradeDir </path/to/upgrade/dir>.
  • --tempZipDir Sets the temporary directory for unzipping the file. For example: upgrade --tempZipDir </path/to/folder>.
  • -h, --help Provides help for this command (this information).


Use the auxiliary:install module to install auxiliary services in Tamr Core. For more information, see Auxiliary Services.


auxiliary:install [--appName <appName>] [--configDefinitions <configDefinitions>] [-h] [--help] [--jarFile <jarFile>] [--runtimeConfig <runtimeConfig>]


  • --appName The name of the auxiliary service in Tamr Core, such as connect.
  • --configDefinitions The path to the definitions file of the auxiliary service, such as <directory-path-of-definitions-file>/definitions.yaml.
  • --jarFile The path to the JAR file of the auxiliary service, such as <directory-path-of-jar-file>/connect.jar.
  • --runtimeConfig The path to the yaml file of the auxiliary service, such as <directory-path-of-jar-file>/connect.yaml.
  • -h, --help Provides help for this command (this information).



maintenance [--force] [-h] [--list] [--script]


Use the ./ maintenance utility to run non-essential helper scripts.

  • --force Do not prompt for confirmation, follow script's default behavior when executing.
  • -h,--help Provides help for this command (this information).
  • --list Lists available maintenance scripts.
  • --script Specify the name of the maintenance script to run.

Available Scripts

  • DisablePKMgmtForNonEquiJoinLookups
    Automated primary key management is now enabled by default for all LOOKUP statements that do not have equality join conditions. When this feature was added, this script was used to add hints to disable primary key management for all LOOKUP statements without equality join conditions so that all existing labels remained valid.
  • CleanupIncompletelyDeletedProjects
    Garbage collect all orphaned recipes associated with deleted projects and detach derived datasets associated with deleted projects into source datasets. See Dataset Cleanup.
  • DisablePKManagement
    This script disables primary key management for all projects that the user has access to. See When to Disable Automatic Primary Key Management.