NI LabVIEW Command Line Interface - Revision history

Logmanoriginal: /* Operations */ Add CreateComparisonReport

2025-08-28T12:09:58Z

Operations: Add CreateComparisonReport

← Older revision		Revision as of 12:09, 28 August 2025
Line 51:		Line 51:

	* [[CloseLabVIEW]]		* [[CloseLabVIEW]]
			* [[CreateComparisonReport]]
	* [[ExecuteBuildSpec]]		* [[ExecuteBuildSpec]]
	* [[MassCompile]]		* [[MassCompile]]

Logmanoriginal: /* History */ Add versions 2025 Q1 and Q3

2025-08-28T12:08:12Z

History: Add versions 2025 Q1 and Q3

← Older revision		Revision as of 12:08, 28 August 2025
Line 63:		Line 63:

	==History==		==History==
			{{history\|product=NI LabVIEW Command Line Interface\|2025 Q3\|
			* Added [[CreateComparisonReport]]
			}}

			{{history\|product=NI LabVIEW Command Line Interface\|2025 Q1\|}}

	{{history\|product=NI LabVIEW Command Line Interface\|2024 Q3\|}}		{{history\|product=NI LabVIEW Command Line Interface\|2024 Q3\|}}

Logmanoriginal: Simplify options list

2025-01-04T06:34:02Z

Simplify options list

← Older revision		Revision as of 06:34, 4 January 2025
Line 20:		Line 20:
	==Options==		==Options==

	;~~'''~~-OperationName <name> [<arg>...]~~'''~~		;-OperationName <name> [<arg>...]
	:Runs the specified operation. If the operation has additional arguments, they must be specified after the operation name.		:Runs the specified operation. If the operation has additional arguments, they must be specified after the operation name.

	;~~'''~~-AdditionalOperationDirectory <path>~~'''~~		;-AdditionalOperationDirectory <path>
	:Specifies the directory where additional operations are located.		:Specifies the directory where additional operations are located.

	;~~'''~~-LabVIEWPath <path>~~'''~~		;-LabVIEWPath <path>
	:Specifies the path to the LabVIEW executable to use. This argument is required on macOS and Linux but optional on Windows. On Windows, it defaults to the most recently started version of LabVIEW.		:Specifies the path to the LabVIEW executable to use. This argument is required on macOS and Linux but optional on Windows. On Windows, it defaults to the most recently started version of LabVIEW.

	;~~'''~~-PortNumber <number>~~'''~~		;-PortNumber <number>
	:Specifies the port number to use for the LabVIEW CLI server. The default port number is 3363.		:Specifies the port number to use for the LabVIEW CLI server. The default port number is 3363.

	;~~'''~~-LogFilePath <path>~~'''~~		;-LogFilePath <path>
	:Specifies the path to the log file. If not specified, the log file is created in the temporary directory.		:Specifies the path to the log file. If not specified, the log file is created in the temporary directory.

	;~~'''~~-LogToConsole (true\|false)~~'''~~		;-LogToConsole (true\|false)
	:Specifies whether to log messages to the console. The default value is ''true''.		:Specifies whether to log messages to the console. The default value is ''true''.

	;~~'''~~-Verbosity (Minimal\|Default\|Detailed\|Diagnostic)~~'''~~		;-Verbosity (Minimal\|Default\|Detailed\|Diagnostic)
	:Specifies the verbosity level of the log messages. Available options are: ''Minimal'', ''Default'', ''Detailed'', and ''Diagnostic''. The default value is ''Default''.		:Specifies the verbosity level of the log messages. Available options are: ''Minimal'', ''Default'', ''Detailed'', and ''Diagnostic''. The default value is ''Default''.

Logmanoriginal: Add -Help option

2025-01-04T06:33:19Z

Add -Help option

← Older revision		Revision as of 06:33, 4 January 2025
Line 16:		Line 16:
	[-LogToConsole (true\|false)]		[-LogToConsole (true\|false)]
	[-Verbosity (Minimal\|Default\|Detailed\|Diagnostic)]		[-Verbosity (Minimal\|Default\|Detailed\|Diagnostic)]
			[-Help]

	==Options==		==Options==
Line 39:		Line 40:
	;'''-Verbosity (Minimal\|Default\|Detailed\|Diagnostic)'''		;'''-Verbosity (Minimal\|Default\|Detailed\|Diagnostic)'''
	:Specifies the verbosity level of the log messages. Available options are: ''Minimal'', ''Default'', ''Detailed'', and ''Diagnostic''. The default value is ''Default''.		:Specifies the verbosity level of the log messages. Available options are: ''Minimal'', ''Default'', ''Detailed'', and ''Diagnostic''. The default value is ''Default''.

			;-Help
			:Display help text for the specified operation.

	==Operations==		==Operations==

Logmanoriginal: Add categories

2025-01-02T14:56:21Z

Add categories

← Older revision		Revision as of 14:56, 2 January 2025
Line 87:		Line 87:
	<ref name="labviewcli-product-description">[https://www.ni.com/en/support/downloads/software-products/download.ni-labview-command-line-interface.html NI LabVIEW Command Line Interface Download Page]</ref>		<ref name="labviewcli-product-description">[https://www.ni.com/en/support/downloads/software-products/download.ni-labview-command-line-interface.html NI LabVIEW Command Line Interface Download Page]</ref>
	}}		}}
			[[Category:LabVIEW add-ons]]
			[[Category:NI LabVIEW Command Line Interface]]

Logmanoriginal: /* See also */ Add link to List of LabVIEW add-ons

2025-01-02T14:41:22Z

See also: Add link to List of LabVIEW add-ons

← Older revision		Revision as of 14:41, 2 January 2025
Line 76:		Line 76:

	==See also==		==See also==
			* [[List of LabVIEW add-ons]]
	* [[G-CLI]]		* [[G-CLI]]

Logmanoriginal: Add note about LabVIEW Full

2025-01-02T14:39:17Z

Add note about LabVIEW Full

← Older revision		Revision as of 14:39, 2 January 2025
Line 1:		Line 1:
	'''NI LabVIEW Command Line Interface''' ''(Command Line Interface for LabVIEW, LabVIEW CLI)'' is a [[List of LabVIEW add-ons\|LabVIEW add-on]] that exposes operations that can be called directly from the command line. It was first introduced in [[LabVIEW 2014]].		'''NI LabVIEW Command Line Interface''' ''(Command Line Interface for LabVIEW, LabVIEW CLI)'' is a [[List of LabVIEW add-ons\|LabVIEW add-on]] that exposes operations that can be called directly from the command line. It was first introduced in [[LabVIEW 2014]] and is included with [[LabVIEW Full]] and higher tiers.

	<blockquote>		<blockquote>

Logmanoriginal: Created page with "'''NI LabVIEW Command Line Interface''' ''(Command Line Interface for LabVIEW, LabVIEW CLI)'' is a LabVIEW add-on that exposes operations that can be called directly from the command line. It was first introduced in LabVIEW 2014.
The NI LabVIEW Command Line Interface (CLI) is a software add-on for LabVIEW. You can use it to automate the build process of LabVIEW applications and run the VIs and custom operations you create in..."

2025-01-02T14:05:53Z

Created page with "'''NI LabVIEW Command Line Interface''' ''(Command Line Interface for LabVIEW, LabVIEW CLI)'' is a LabVIEW add-on that exposes operations that can be called directly from the command line. It was first introduced in LabVIEW 2014. <blockquote> The NI LabVIEW Command Line Interface (CLI) is a software add-on for LabVIEW. You can use it to automate the build process of LabVIEW applications and run the VIs and custom operations you create in..."

New page

'''NI LabVIEW Command Line Interface''' ''(Command Line Interface for LabVIEW, LabVIEW CLI)'' is a [[List of LabVIEW add-ons|LabVIEW add-on]] that exposes operations that can be called directly from the command line. It was first introduced in [[LabVIEW 2014]].

<blockquote>
The NI LabVIEW Command Line Interface (CLI) is a software add-on for LabVIEW. You can use it to automate the build process of LabVIEW applications and run the VIs and custom operations you create in LabVIEW.<ref group="ni" name="labviewcli-product-description" />
</blockquote>

LabVIEW CLI is installed in the version-independent ''Shared'' directory of LabVIEW and is therefore available to all installed versions of LabVIEW starting with LabVIEW 2014. This also means that all operations are written in LabVIEW 2014 to ensure compatibility with all supported versions of LabVIEW.

==Synopsis==

LabVIEWCLI -OperationName <name> [<arg>...]
[-AdditionalOperationDirectory <path>]
[-LabVIEWPath <path>]
[-PortNumber <number>]
[-LogFilePath <path>]
[-LogToConsole (true|false)]
[-Verbosity (Minimal|Default|Detailed|Diagnostic)]

==Options==

;'''-OperationName <name> [<arg>...]'''
:Runs the specified operation. If the operation has additional arguments, they must be specified after the operation name.

;'''-AdditionalOperationDirectory <path>'''
:Specifies the directory where additional operations are located.

;'''-LabVIEWPath <path>'''
:Specifies the path to the LabVIEW executable to use. This argument is required on macOS and Linux but optional on Windows. On Windows, it defaults to the most recently started version of LabVIEW.

;'''-PortNumber <number>'''
:Specifies the port number to use for the LabVIEW CLI server. The default port number is 3363.

;'''-LogFilePath <path>'''
:Specifies the path to the log file. If not specified, the log file is created in the temporary directory.

;'''-LogToConsole (true|false)'''
:Specifies whether to log messages to the console. The default value is ''true''.

;'''-Verbosity (Minimal|Default|Detailed|Diagnostic)'''
:Specifies the verbosity level of the log messages. Available options are: ''Minimal'', ''Default'', ''Detailed'', and ''Diagnostic''. The default value is ''Default''.

==Operations==
Operations are individual tasks that LabVIEW CLI can execute. Each operation has a unique name and can be called with additional arguments from the command line.

===Predefined operations===
LabVIEW CLI includes a set of predefined operations that can be called from the command line:

* [[CloseLabVIEW]]
* [[ExecuteBuildSpec]]
* [[MassCompile]]
* [[RunUnitTests]]
* [[RunVI]]
* [[RunVIAnalyzer]]

Additionally, custom operations can be created to extend the functionality of LabVIEW CLI.

===Custom operations===
The functionality of LabVIEW CLI can be extended with custom operations. Custom operations are created by inheriting from [[CoreOperation]] and overriding ''GetHelp'' and ''RunOperation''.

==History==
{{history|product=NI LabVIEW Command Line Interface|2024 Q3|}}

{{history|product=NI LabVIEW Command Line Interface|2024 Q1|}}

{{history|product=NI LabVIEW Command Line Interface|2023 Q3|}}

{{history|product=NI LabVIEW Command Line Interface|2023 Q1|}}

{{history|product=NI LabVIEW Command Line Interface|3.0|}}

{{history|product=NI LabVIEW Command Line Interface|2.1|}}

{{history|product=NI LabVIEW Command Line Interface|2.0|}}

{{history|product=NI LabVIEW Command Line Interface|1.1|}}

==See also==
* [[G-CLI]]

==External links==
* [https://www.ni.com/docs/en-US/bundle/labview/page/predefined-command-line-operations.html Predefined Command Line Operations] (LabVIEW User Manual)
* [https://www.ni.com/docs/en-US/bundle/labview/page/creating-custom-command-line-operations.html Creating Custom Command Line Operations] (LabVIEW User Manual)

==References==
{{reflist|group=ni|refs=
<ref name="labviewcli-product-description">[https://www.ni.com/en/support/downloads/software-products/download.ni-labview-command-line-interface.html NI LabVIEW Command Line Interface Download Page]</ref>
}}