The Fundamentals
A Command Line Interface (CLI) tool allows you to interact with software using textual commands in a terminal or command prompt. The Metrix Sync CLI tool follows this paradigm, enabling you to perform various operations such as checking for updates, registering API tokens, and more, directly from your terminal.
Basic usage typically involves running the tool followed by a command and any options or arguments that the command requires. For example:
./metrix-sync.exe <command> [options]Users may note the use of the ./ pattern, followed by the name of an executable (.exe) file. This is a common convention in
command-line usage, and it means:
./indicates that the executable file is located in the current directory.metrix-sync.exeis the name of the executable file being run.
Assume you download the Metrix Sync CLI tool, and save it to a specific directory on your network - say, T:\tools\metrix.
You would need to ensure your terminal’s current working directory is set to the location where you saved the executable file.
In this example, you would navigate to T:\tools\metrix before running the tool. Below, we show the use of the cd command
to change the current working directory to the location of the executable file.
cd T:\tools\metrixNext, lets assume you name the executable file metrix-sync.exe.
In this case (remembering that we are already in the directory where the executable file is located) you would run the tool from the terminal as follows:
./metrix-sync.exeThe above will launch the Metrix Sync CLI tool (without invoking any actual tools to run).