Normally Palatable Mango


    1.5.0 • Public • Published

    SuiteCloud CLI for Node.js

    npm-cli npm-cli

    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:

    • Node.js version 16.14.2 LTS
    • Oracle JDK version 11

    Read the full list of prerequisites in NetSuite's Help Center.

    Supported Versions

    Although you may have access to older versions of CLI for Node.js, only the versions in this section are officially supported.

    Each version of CLI for Node.js in NPM works optimally with a specific NetSuite version. To check the equivalence among versions, see the following table:

    Version in NPM Version in NetSuite
    1.5.X 2022.1
    1.3.X 2021.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 the 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 (authid) 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 the 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 custom objects from an account to your SuiteCloud project.
    object:list Lists the custom objects deployed in an account.
    object:update Overwrites the custom objects in the project with the custom objects from an account.
    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 NetSuite's Help Center.

    Getting Started

    🎞 To see how to install and set up CLI for Node.js, watch the following video:

    Setting up CLI for Node.js 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 2022.1 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) 2022 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0.

    By installing the SuiteCloud CLI for Node.js, you are accepting the installation of the SuiteCloud SDK dependency under the Oracle Free Use Terms and Conditions license.


    npm i @oracle/suitecloud-cli

    DownloadsWeekly Downloads






    Unpacked Size

    496 kB

    Total Files


    Last publish


    • vic-nik
    • karl-anthony-ng
    • drebolleda
    • lfpvillegas
    • antoniofruci