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 18.14.2 LTS
- Oracle JDK version 17
Read the full list of prerequisites in SuiteCloud CLI for Node.js Installation Prerequisites.
Supported Versions
You should use the latest version of the SuiteCloud CLI for Node.js available in NPM. The table below is informative and correlates CLI versions in NPM and NetSuite versions.
| Version in NPM | Version in NetSuite |
|---|---|
| 1.9.X | 2024.1 |
| 1.8.X | 2023.2 |
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-cli
When installing SuiteCloud CLI for Node.js via script, for instance in a CI environment, you can skip showing the license presented during the normal installation process by adding the --acceptSuiteCloudSDKLicense flag to the install script as shown below. Note that by adding the mentioned flag to the script, you confirm that you have read and accepted the Oracle Free Use Terms and Conditions license. See the License section for details.
npm install -g --acceptSuiteCloudSDKLicense @oracle/suitecloud-cli
CLI 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:savetoken |
Saves a TBA token that you issued previously in NetSuite. |
account:setup |
Sets up an account to use with SuiteCloud CLI for Node.js. |
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. |
To check the help for a specific command, run the following command:
suitecloud {command} -h
Read 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 -i
After you create a project, configure a NetSuite account, by running the following command within the project folder:
suitecloud account:setup
Release Notes & Documentation
To read the 2024.1 NetSuite's release notes and documentation, check the following sections of NetSuite's Help Center:
- Read the release notes for NetSuite 2024.1 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
SuiteCloud CLI for Node.js is an open source project. Pull Requests are currently not being accepted. See Contributing for details.
License
Copyright (c) 2022, 2023, 2024 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.