Adding the Path to Harmony Utilities to the System's List of Paths
By default, to run a Harmony utility, you must type its full path followed by its name in the command line. The full path of the utility includes the path in which Harmony was installed. If you installed Harmony in its default installation directory, the path will be as follows:
- Windows: C:\Program Files (x86)\Toon Boom Animation\Toon Boom Harmony 15.0 Premium\win64\bin
- macOS (Stand Alone):/Applications/Toon Boom Harmony 15.0 Premium/tba/macosx/bin
- macOS (Server): /Applications/Toon Boom Harmony 15.0 Premium Network/tba/macosx/bin
- GNU/Linux:/usr/local/ToonBoomAnimation/harmonyPremium_15.0/lnx86_64/bin
So, for example, if you wish to run utransform on Windows, you would have to type C:\Program Files (x86)\Toon Boom Animation\Toon Boom Harmony 15.0 Premium\win64\bin\utransform into the command line. This can get tedious and time consuming, especially if you intend to run utilities routinely.
If you prefer, you can add the path to Harmony's command line utilities to your system's list of default paths for commands. When you attempt to run a command without specifying its path, the operating system looks for an utility that matches the name of the command in every folder in the list of paths, and if it finds it, it runs that utility. This is why most command line utilities bundled with your operating system can be launched by simply typing their name. By adding the path to Harmony's command line utilities to this list, merely typing the name of the utility into a command line will be enough to run it.
- From the Start menu, in the programs list, select Toon BoomToon Boom Harmony 15.0 Premium and launch the Configuration Wizard.
- In the main menu of the Configuration Wizard, select Add Harmony to Path.
- In the next panel, select the scope to which to add the path to:
- Single User: This will only add Harmony to your list of paths when you're logged in as the user you are currently logged into.
- All Users: The path to Harmony will always be in the list of system paths, regardless of which user is logged on.
- Select Next.
- Click on Finish.
The next time you open a Command Prompt, the path to Harmony will be included in the system's list of paths and you will be able to launch Harmony command line utilities by only typing their file name rather than their full file path.
- Open Finder, then select Applications > Toon Boom Harmony 15.0 Premium > Tools > Configuration Assistant.
- In the main menu of the Configuration Assistant, check the Register console application in the path option. Uncheck all other options and select Continue.
- In the next panel, select the scope to which to add the path to:
- Register Path for all users: The path to Harmony will always be in the list of system paths, regardless of which user is logged on.
- Register Path for my user only: This will only add Harmony to your list of paths when you're logged in as the user you are currently logged into.
- Click on Create.
The next time you open a Terminal, the path to Harmony will be included in the system's list of paths and you will be able to launch Harmony command line utilities by only typing their file name rather than their full file path.
If you want to remove Harmony from your path, you must manually edit out the configuration file in which it was stored:
- If you added Harmony to the path for all users, open /etc/profile in an editor.
- If you added Harmony to the path for your own user, open ~/.profile in an editor.
Then, remove the block betwen # BEGIN HARMONY PATH REGISTRATION and # END HARMONY PATH REGISTRATION.
- Locate the installer package that was used to install Harmony on your machine. If you deleted it, download it and unpack it again with the following command:
- Switch to the directory in which the installer package was unpacked:
- Type in the following command:
- In the installer, read and agree to the End User License Agreement.
- Confirm that you want to add Harmony to the PATH environment variable.
- Once the operation is done, reboot the machine.
tar -xvzf <name of package>
cd <path to extracted installer package>
sudo ./install -e
The installer will launch.
The path to Harmony will be included in the system's list of paths.