1. SuiteCloud Platform
  2. SuiteCloud SDK
  3. SuiteCloud CLI
  4. SuiteCloud CLI for Java
  5. SuiteCloud CLI for Java Reference
  6. SuiteCloud CLI for Java Commands
  7. deploy

deploy

Deploys the folder or ZIP file with your SuiteCloud project.

The SuiteCloud project folder gets zipped before deployment. Only the files and folders listed in the deploy.xml file are included in the ZIP file.

Important:

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

Syntax

          deploy [-authid AuthId]
    [-p FolderOrZipFile]
    [-applyinstallprefs]
    [-l LogPathOrFile]
    [-np]
    [-v]
    [-sw]
    [-accountspecificvalues (WARNING|ERROR)]

Options

Option

Required / Optional

Description

-authid

Required

References the custom alias you give to a specific account-role combination.

-p

Required when a default project has not been specified by the project command or when you want to specify a project other than the default. For more information, see project.

References the folder or ZIP file with your SuiteCloud project.

-applyinstallprefs

Required when locking.xml, hiding.xml, and overwriting.xml exist in the InstallationPreferences folder of a SuiteApp project.

Indicates whether installation preferences should be applied.

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

-accountspecificvalues

Optional

Indicates how to handle account-specific values in an account customization project.

If you set this to WARNING and there are account-specific values in the project, you get a warning but deployment continues.

If you set this to ERROR and there are account-specific values in the project, you get an error message and deployment stops.

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.

-l

Optional

Specifies the deployment log file location as a directory path or a file name.

If you specify a directory, the log file is created there by default.

Deployment log details are added to the end of the file.

-np

Optional

Skips the preview step.

-v

Optional

Starts client-side project validation.

Deployment stops if any errors occur during this process.

-sw

Optional

Removes the warning you get before deploying to a production account.

-h or -help

Optional

Prints the help for this command.

Example

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

sdfcli deploy -authid AuthId -p c:/project/ -l d:/path/test.log -np -v

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

          SuiteCloud Development Framework CLI (com.netsuite.ide.core_2021.1.0)
Enter password: 
Deploy "c:\project".
2021-04-02 11:08:23 (PST) Installation started
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
2021-04-02 11:08:23 (PST) Installation COMPLETE (0 minutes 1 second)

Writing to log file d:\path\test.log.

Related Topics

General Notices