Home
Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
Command-line client (CLI) reference
CLI is a command-line interface that provides access to the HCL DevOps Deploy (Deploy) server. It can be used to find or set properties and to run numerous functions.
Installing the command-line client
The command-line client is available in an archive file that you can download from the server.

Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
- Plug-ins
  The HCL plug-ins provide tools for creating component processes and integrations. HCL plug-ins provides plug-ins for several common deployment processes, and others are available to integrate with a wide variety of tools, such as middleware tools, databases, and servers.
- Creating notification templates
  Notification templates are the basis for emails that the server sends to users after an event occurs on the server. You can create customized notification templates by modifying the default templates provided, or by creating new templates of your own.
- REST API reference
  You can use these REST interfaces to automate tasks.
- Command-line client (CLI) reference
  CLI is a command-line interface that provides access to the HCL DevOps Deploy (Deploy) server. It can be used to find or set properties and to run numerous functions.
  - Installing the command-line client
    The command-line client is available in an archive file that you can download from the server.
  - Command format
    To run a command, open a command-line window and specify the command and its parameters. In some cases, you must pass a JSON string with information for a command.
  - CLI Commands
    The following list shows the commands that are available.
- Process-as-code feature
  Programmatically manage processes with PAC language.

Installing the command-line client

The command-line client is available in an archive file that you can download from the server.

Before you begin

Make sure that the JAVA_HOME system variable is set to the location of a JRE or JVM.

About this task

Beginning with Deploy version 6.1, the command-line client is installed on agents automatically. The client is in the folder agent_install/opt/udclient.

Procedure

To install the tool, download the udclient.zip file to the system on which you want to use the tool.
You can download the file from the Deploy server by clicking Help > Tools and then clicking Deploy Client. You can also find the file in the folder server_install/opt/tomcat/webapps/ROOT/tools/, where server_install is the installation folder for the server.
Extract the file.
Optional: Set system variables such as DS_WEB_URL so you do not have to specify credentials each time you run a command.
See Command format.

What to do next

For information about specific commands, see CLI Commands.