1. SuiteCloud Platform
  2. SuiteCloud SDK
  3. SuiteCloud CLI
  4. SuiteCloud CLI for Node.js
  5. SuiteCloud CLI for Node.js Reference
  6. project:deploy

project:deploy

Deploys the folder containing the SuiteCloud project. The project folder is zipped before deployment, only including the files and folders referenced in the deploy.xml file.

If you run suitecloud project:deploy with no options, the project is not validated locally and is deployed without applying installation preferences. Account-specific values are labeled as error messages and stop the deployment.

Important:

For installation script, installation preference, and translation collection objects, files referenced within their XML structure are also deployed. Even if these files are not part of the deploy.xml file.

Syntax

            project:deploy [--applyinstallprefs] [--validate] [--sw] [--accountspecificvalues (WARNING|ERROR)]

Options

Option

Required / Optional

Description

--applyinstallprefs

Optional for SuiteApps

Applies the settings from the hiding.xml, locking.xml files, and overwriting.xml files. Enter T to apply them, or F to ignore them.

For more information, see Installation Preferences in the SuiteApp of SuiteCloud Project

--accountspecificvalues

Optional for ACPs

Flag account-specific values as either a warning or an error. Enter ERROR or WARNING.

If the argument value is WARNING and there are account-specific values in the project, a warning message is thrown but the deployment can continue.

If the argument value is ERROR and there are account-specific values in the project, and error message is thrown and deployment stops.

For more information, see Account-Specific Values Validation in SuiteCloud Projects.

Important:

If the --accountspecificvalues option is not specified, the behavior is the same as passing ERROR as an argument.

--dryrun or --dryrun

Optional

Runs a preview of your deploy process. Your project is not deployed.

Important:

This option can only be used in non-interactive mode.

-i or --interactive

Optional

Runs the command in interactive mode.

-l or --log

Optional

Sets the deployment log file location, as either a directory or a file name.

If it is a directory, a default log file is generated in the specified location.

Important:

If a log file already exists in the specified location, deployment log details are appended to that existing file.

-v or --validate

Optional

Starts client-side project validation.

The deployment stops when any errors occur during this process.

--help

Optional

Prints the help for this command.

Interactive Example

The following command deploys a SuiteCloud project to an account using the interactive mode. It also creates a log of the deployment process:

            suitecloud project:deploy

Before you run the command, the following questions are prompted:

            Do you want to apply installation preferences? > Yes No
What do you want to do if the project contains account-specific values? Display a warning > Cancel the process

Non-interactive Example

The following command deploys an Account Customization Project to an account using the non-interactive mode. It also creates a log of the deployment process:

            suitecloud project:deploy --applyinstallprefs -v

Output Example

When you run the command, it produces an output that is similar to the following:

            Info -- Account [(PRODUCTION) Wolfe Electronics]
Info -- Account Customization Project [Project]
Info -- Framework Version [1.0]
Validate manifest -- Success
Validate deploy file -- Success
Validate configuration -- Success
Validate script file -- Success
Validate objects -- Success
Validate resource files -- Success
Validate account settings -- Success
Begin deployment
2019-08-10 11:08:23 (PST) Installation COMPLETE (0 minutes 3 second)

Related Topics

General Notices