SuiteCloud CLI for Node.js Reference

You can use SuiteCloud CLI for Node.js to manage SuiteCloud project components and validate and deploy projects to your account.

SuiteCloud CLI for Node.js Syntax

            suitecloud <command> <option> <argument>

Important:

If an argument is enclosed in angle brackets (<argument>)), it's required. If it's enclosed in brackets ([argument]), it's optional.

SuiteCloud CLI for Node.js Commands Reference

Command	Description
account:manageauth	Manages authentication IDs for all your projects.
account:setup	Sets up an account to use with SuiteCloud CLI for Node.js. This command only works in interactive mode. Sets up an account to use with SuiteCloud SDK and configures the default auth ID for the SuiteCloud project. It requires browser-based login to NetSuite.
account:setup:ci	Sets up an account to use with SuiteCloud SDK and configures the default auth ID for the SuiteCloud project. It does not require browser-based login to NetSuite. This command is helpful for automated environments such as CI.
file:create	Creates a SuiteScript file in the selected folder.
file:import	Imports files from an account to your Account Customization Project.
file:list	Lists the files in your account's File Cabinet.
file:upload	Uploads files from your project to your account.
object:import	Imports SDF custom objects from an account to your SuiteCloud project.
object:list	Lists the SDF custom objects deployed in your account.
object:update	Overwrites the SDF custom objects in your project with the matching ones from your account. In the case of custom records, you can include custom instances.
project:adddependencies	Adds any missing dependencies to the manifest file.
project:create	Creates a SuiteCloud project, either a SuiteApp or an Account Customization Project (ACP).
project:deploy	Deploys the folder containing your project.
project:package	Generates a ZIP file from your project, following the structure specified in the `deploy.xml` file.
project:validate	Validates your SuiteCloud project folder.

Command

Description

account:manageauth

Manages authentication IDs for all your projects.

account:setup

Sets up an account to use with SuiteCloud CLI for Node.js.

This command only works in interactive mode.

Sets up an account to use with SuiteCloud SDK and configures the default auth ID for the SuiteCloud project.

It requires browser-based login to NetSuite.

account:setup:ci

Sets up an account to use with SuiteCloud SDK and configures the default auth ID for the SuiteCloud project. It does not require browser-based login to NetSuite. This command is helpful for automated environments such as CI.

file:create

Creates a SuiteScript file in the selected folder.

file:import

Imports files from an account to your Account Customization Project.

file:list

Lists the files in your account's File Cabinet.

file:upload

Uploads files from your project to your account.

object:import

Imports SDF custom objects from an account to your SuiteCloud project.

object:list

Lists the SDF custom objects deployed in your account.

object:update

Overwrites the SDF custom objects in your project with the matching ones from your account. In the case of custom records, you can include custom instances.

project:adddependencies

Adds any missing dependencies to the manifest file.

project:create

Creates a SuiteCloud project, either a SuiteApp or an Account Customization Project (ACP).

project:deploy

Deploys the folder containing your project.

project:package

Generates a ZIP file from your project, following the structure specified in the deploy.xml file.

project:validate

Validates your SuiteCloud project folder.

General Notices