Initializing help system before first use

Command-Line Tool for Common Operations

In addition to the interactive user interface, Workbench provides a simple command-line interface for common operations. The tool is called xpwinsightcmd, and its filename and location vary by platform.
  • On Windows, the xpwinsightcmd.bat file is in the workbench folder.
  • On macOS the xpwinsightcmd.sh file is in the bin folder.

On Windows, the tool can be invoked as xpwinsightcmd or xpwinsightcmd.bat, and on macOS as xpwinsightcmd.sh. The Windows installer and the macOS xpvars.sh script update your PATH environment variable to include the folder locations of the tool.

The output of xpwinsightcmd is the same as you would see in the terminal windows when performing the equivalent actions in the Workbench UI. Running the tool without any arguments prints the available options, and the process exits with an error code.

No action supplied
xpwinsightcmd options:
xpwinsightcmd build [--base path/to/project] [-g | -G] path/to/main/file
xpwinsightcmd publish [--base path/to/project] path/to/main/file --to URL
         [--app-name app-name] [--app-id app-id] [--create-if-missing]
         [--full] [--prod]
         [--exec-env name]
         [--insight-4 --user userid --pw pw]
Note: The output in the example above is from macOS and uses forward slashes ( /) in its paths; on Windows backslashes ( \) should be used. Likewise, if paths or other command-line arguments contains spaces or other complex characters, those arguments should be escaped or quoted in an OS-appropriate manner.
Note: This tool is focused on operations related to the development and deployment of Insight apps. For command-line access to actions based around Xpress itself and no relation to Insight (e.g. compiling or running a Mosel model), use the Xpress command-line tools such as mosel (.exe)
Covered Topics
  • Command-Line Tool Options and Arguments
    The --base option is shared by all actions and is used to specify the root directory of the Workbench project (the parent of the source or python_source folder). If this option is omitted, then the current working directory is used as the base. Other file path arguments are relative to this base directory.
Parent Topic Working with Xpress Insight

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.