Help Center/ CodeArts Deploy/ User Guide/ Creating and Deploying an Application with a Blank Template/ Configuring Application Deployment Actions/ Configuring Deployment Actions for Running Commands/ Running Shell Scripts
Updated on 2025-07-03 GMT+08:00
View PDF

Running Shell Scripts

This action aims to run shell scripts on a host in a specified environment. The following table shows the configuration.

Table 1 Parameters

Parameter

Description

Action Name

Customized action name displayed in the deployment actions Enter 1 to 128 characters. Do not start or end with a space. Use letters, digits, spaces, and these special characters: -_,;:./()

Environment

Select a host cluster as the deployment object.

Running Mode

Default and Background are available.

NOTE:
  • Default: The result is printed, but the related service or process cannot be started.
  • Background: The service or process can be started, but the result will not be printed.

Shell Script Path

Path of the shell script on the target host.

Running Parameters

Before executing the script, set parameters. During script execution, the entered parameter values are loaded and used.

Action Control

You can configure whether to enable this setting.

  • Keep running on failure: whether to continue the task even if this action fails.
  • Execute this action with the sudo permission: whether to use the sudo permission to deploy this action.

How Do I Use Script Execution Parameters?

  1. Use $1, $2, and similar formats in the shell script to reference parameter. For example, the content of the hello.sh script is shown in the following figure.

    Figure 1 Script content

  2. Separate running parameters with spaces, as shown in the following figure.

    Figure 2 Entering running parameters

  3. View the result.

    In the script, $1 is replaced with test2, and the test2 directory is created.

    Figure 3 Viewing the result

If you encounter any problem during deployment, see Solutions to Common Problems.