project:deploy

Deploys the folder containing your SuiteCloud project. The folder gets 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 isn't 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 in their XML structure are also deployed, even if those files aren't part of the deploy.xml file.

Syntax

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

Options

Option	Required / Optional	Description
--applyinstallprefs	Optional for SuiteApps	Applies the settings from the `hiding.xml`, `locking.xml`, 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	Flags account-specific values as either a warning or an error. Enter `ERROR` or `WARNING`. If you set the argument value is to `WARNING` and there are account-specific values in the project, you'll get a warning but deployment will continue. If you set the argument value to `ERROR` and there are account-specific values in the project, you'll get an error and deployment will stop. For more information, see Account-Specific Values Validation in SuiteCloud Projects. Important: If you don't specify the `--accountspecificvalues` option, it acts the same as if you passed ERROR.
-- dryrun or -- dryrun	Optional	Runs a preview of your deployment process. Your project isn't deployed. Important: You can only use this option in non-interactive mode.
-i or --interactive	Optional	Runs the command in interactive mode.
-l or --log	Optional	Sets the deployment log file location, either as a directory or a file name. If you specify a directory, a default log file is created in that location. Important: If a log file already exists in that location, deployment log details are added to that existing file.
-v or --validate	Optional	Starts client-side project validation. Deployment stops if any errors occur during this process.
--help	Optional	Prints the help for this command.

Option

Required / Optional

Description

--applyinstallprefs

Optional for SuiteApps

Applies the settings from the hiding.xml, locking.xml, 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

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

If you set the argument value is to WARNING and there are account-specific values in the project, you'll get a warning but deployment will continue.

If you set the argument value to ERROR and there are account-specific values in the project, you'll get an error and deployment will stop.

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

Important:

If you don't specify the --accountspecificvalues option, it acts the same as if you passed ERROR.

-- dryrun or -- dryrun

Optional

Runs a preview of your deployment process. Your project isn't deployed.

Important:

You can only use this option in non-interactive mode.

-i or --interactive

Optional

Runs the command in interactive mode.

-l or --log

Optional

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

If you specify a directory, a default log file is created in that location.

Important:

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

-v or --validate

Optional

Starts client-side project validation.

Deployment stops if any errors occur during this process.

--help

Optional

Prints the help for this command.

Interactive Example

Here's a command that deploys a SuiteCloud project to an account using interactive mode and creates a deployment log:

            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

Here's a command that deploys an Account Customization Project to an account using the non-interactive mode. It also creates a deployment log:

            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)

Syntax

Options

Interactive Example

Non-interactive Example

Output Example

Related Topics