ProjectUtility CLI reference

This topic describes every command, sub-command, alias, argument, and option available in the ProjectUtility command line interface.

ProjectUtility helps you manage PcVue projects from the command line, in particular project migration. It is installed locally as part of the PcVue installation, and you can use it from your preferred terminal.

If what you are looking for is a tool with a user interface, use the Host Deployment Console instead.

With the ProjectUtility CLI, you can:

  • Migrate a project, including migrating the user directory.

When installing PcVue, you can select an install location. By default, ProjectUtility.exe is found in C:\Program Files\ARC Informatique\PcVue 17\Bin\

Introduced with version 17, the first command is designed to migrate the user directory configuration from versions earlier than v17.

Commands support the following global options:

  • -h, --help - Provide help about the command or sub-command.
  • -v, --verbose - Enable verbose logging to display detailed progress and diagnostics.
  • -n, --no-color - Disable colored output for plain text consoles or log capture.

ProjectUtility uses plain text as its default output format.

Copy
Commands overview
ProjectUtility migrate [global options] <PROJECT-FOLDER> user-directory [--no-backup]

The following table describes the notation used to document the syntax of Command Line Interface tools:

Notation Description
Text without brackets or braces Element you must type as shown.
<Text inside angle brackets> Placeholder for which you must supply a value. It is usually required to be passed as argument but may also be prompted if necessary.
[Text inside square brackets] Optional element.
Vertical bar (|) Separator for mutually exclusive elements. You must choose one.
  • The ProjectUtility CLI requires Administrative privileges.
  • Close PcVue before executing a command.
  • Rely on the backup mechanism proposed by the CLI for safety.
  • Avoid --no-backup unless you manage backups separately.
  • Use --verbose for troubleshooting.
  • All commands are logged.

Command ProjectUtility migrate - Project migration

Manages project migration.

The command processes a folder corresponding to a project stored in the Application data folder and migrates it so it can be run with the version of PcVue that is installed. It reads configuration files (inputs) and creates the new configuration files (outputs).

Using the --no-backup option is not recommended unless you have an independent backup strategy.

The output includes a message indicating the exact location of the backup file in the Windows temporary folders.

Sub-command ProjectUtility migrate user-directory

Migrates the user directory configuration of a project. The rest of the configuration is left as-is.

Copy
Usage
ProjectUtility migrate [global options] <PROJECT-FOLDER> user-directory [--no-backup]

Arguments:

  • <PROJECT-FOLDER> - Project name or path to the project folder (required)

Options:

  • --no-backup - Disable the automatic creation of a backup before migration.

By default, before writing the new configuration, a backup copy of the current user.dat is created:

  • The backup is located the Windows temporary folders.
  • The exact path of the backup file is displayed in the console output when migration runs.

This ensures that the original configuration can be restored if necessary.

Copy
Example - Migration of the user directory (default behavior with backup)
ProjectUtility migrate "C:\Projects\usr\MyProject" user-directory
Copy
Example - Migration of the user directory with verbose logs and no color
ProjectUtility migrate -v -n "C:\Projects\usr\MyProject" user-directory
Copy
Example - Migration of the user directory without backup
ProjectUtility migrate "C:\Projects\usr\MyProject" user-directory --no-backup

Exit codes

To determine the exit code, run one of the following commands immediately after running the CLI command.

Copy

Windows PowerShell

echo $LASTEXITCODE
Copy

Windows Command Prompt

echo %ERRORLEVEL%

 

The following are the exit code values that can be returned at the end of a command.

Code Meaning
0 The operation completed successfully
1 Unspecified error
2 Invalid project path
3 Invalid input file
4 Invalid output file
5 Initialization failure
6 An instance of the PcVue application is running. The command cannot be executed
7 The command requires Administrative privileges
8 An error occurred while parsing command line arguments

Troubleshooting

  • Command missing
    Use the full syntax:
    ProjectUtility migrate <PROJECT-FOLDER> user-directory
  • Application is not running as Administrator.
    Re-run your console as Administrator.
  • SV is running.
    Close PcVue and re-run your command.
  • Path '<X>' does not exist or is not a folder.
    Verify that the path is correct and accessible.
  • Invalid input file / Invalid output file
    Ensure the user.dat file exists, is readable, and that the destination file is not locked.

Cheat sheet

Here is a compact, practical cheat sheet for ProjectUtility that you can keep next to your terminal.

Global options

Option Description
-h, --help Provide help about the command or sub-command
-v, --verbose Enable verbose logging to display detailed progress and diagnostics
-n, --no-color Disable colored output for plain text consoles or log capture
Copy
Project migration
ProjectUtility migrate [global options] <PROJECT-FOLDER> user-directory [--no-backup]     # Migrate the user directory of a project
Copy
Example
ProjectUtility migrate -v "C:\Projects\usr\MyProject" user-directory