SuiteCloud CLI for Node.js
SuiteCloud Command Line Interface (CLI) for Node.js is a SuiteCloud SDK tool to manage SuiteCloud project components and validate and deploy projects to your account.
CLI for Node.js is an interactive tool that guides you through all the steps of the communication between your local project and your account.
Prerequisites
The following software is required to work with SuiteCloud CLI for Node.js:
- Node.js version 24 LTS
- Oracle JDK version 17 or 21
Read the full list of prerequisites in SuiteCloud CLI for Node.js Installation Prerequisites.
Supported Versions
To ensure that you get the latest features and bug fixes, you should use the latest version of the SuiteCloud CLI for Node.js available in NPM.
The following table shows the CLI versions currently available in NPM.
| CLI Versions Available in NPM |
|---|
| 4.0.0 |
| 3.2.0 |
Installation
Since CLI for Node.js is a development tool, use a global instance to install it by running the following command:
npm install -g @oracle/suitecloud-cliWhen you install SuiteCloud CLI for Node.js through a script, such as in a CI environment, set the SUITECLOUD_CLI_ACCEPT_LICENSE environment variable to true to suppress the license prompt. By setting this variable, you confirm that you have read and accepted the Oracle Free Use Terms and Conditions. For details, see the License section.
SUITECLOUD_CLI_ACCEPT_LICENSE=true npm install -g @oracle/suitecloud-cliIf you use PowerShell, run:
$env:SUITECLOUD_CLI_ACCEPT_LICENSE = 'true'
npm install -g @oracle/suitecloud-cliCLI for Node.js is available from within any directory by running suitecloud.
Usage
CLI for Node.js uses the following syntax:
suitecloud <command> <option> <argument>Commands
| Command | Description |
|---|---|
account:manageauth |
Manages authentication IDs for all your projects. |
account:setup |
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 also allows you to select an existing auth ID for the SuiteCloud project. This command does not require browser-based login to NetSuite and is helpful for automated environments such as CI. |
file:create |
Creates SuiteScript files in the selected folder using the correct template with SuiteScript modules injected. |
file:import |
Imports files from an account to your account customization project. |
file:list |
Lists the files in the File Cabinet of your account. |
file:upload |
Uploads files from your project to an account. |
object:import |
Imports SDF custom objects from an account to your SuiteCloud project. |
object:list |
Lists the SDF custom objects deployed in an account. |
object:update |
Overwrites the SDF custom objects in the project with their matching objects imported from the account. In the case of custom records, custom instances can be included. |
project:adddependencies |
Adds 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 the project. |
project:package |
Generates a ZIP file from your project, respecting the structure specified in the deploy.xml file. |
project:validate |
Validates the folder containing the SuiteCloud project. |
proxy:generatekey |
Generates a new API key for proxy authentication. |
proxy:start |
Starts a local proxy for the SuiteCloud Developer Assistant service. |
To check the help for a specific command, run the following command:
suitecloud {command} -hRead the detailed documentation for all the commands in SuiteCloud CLI for Node.js Reference.
Getting Started
To see how to install and set up CLI for Node.js, watch the following video:
Create a new project in an empty folder by running the following command:
suitecloud project:create -iAfter you create a project, configure a NetSuite account, by running the following command within the project folder:
suitecloud account:setupRelease Notes & Documentation
To read NetSuite release notes and documentation, check the following sections of NetSuite's Help Center:
- Read the latest release notes in SuiteCloud SDK Release Notes.
- Read the latest updates under SuiteCloud SDK in the Help Center Weekly Updates.
- Read the CLI for Node.js documentation in SuiteCloud CLI for Node.js Guide.
Contributing
This project welcomes contributions from the community. Before submitting a pull request, review our contribution guide.
License
Copyright (c) 2019, 2023 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0.
By installing SuiteCloud CLI for Node.js, you are accepting the installation of the SuiteCloud SDK dependency under the Oracle Free Use Terms and Conditions license.