@oracle/suitecloud-cli
Advanced tools
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.
The following software is required to work with SuiteCloud CLI for Node.js:
Read the full list of prerequisites in SuiteCloud CLI for Node.js Installation Prerequisites.
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 | Available Since | Compatible NetSuite Version |
|---|---|---|
| 3.1.0 | 2025.2 | 2025.1 and 2025.2 |
| 3.0.2 | 2025.2 | 2025.1 and 2025.2 |
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.
CLI for Node.js uses the following syntax:
suitecloud <command> <option> <argument>
| 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. |
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.
🎞 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
To read the 2025.2 NetSuite's release notes and documentation, check the following sections of NetSuite's Help Center:
SuiteCloud CLI for Node.js is an open source project. Pull Requests are currently not being accepted. See Contributing for details.
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.
FAQs
SuiteCloud CLI for Node.js
The npm package @oracle/suitecloud-cli receives a total of 3,005 weekly downloads. As such, @oracle/suitecloud-cli popularity was classified as popular.
We found that @oracle/suitecloud-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Socket researchers uncover how threat actors weaponize Discord across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Socket now integrates with Bun 1.3’s Security Scanner API to block risky packages at install time and enforce your organization’s policies in local dev and CI.
Research
The Socket Threat Research Team is tracking weekly intrusions into the npm registry that follow a repeatable adversarial playbook used by North Korean state-sponsored actors.