Need private packages and team management tools?Check out npm Teams »

@oracle/suitecloud-cli

1.0.4 • Public • Published

SuiteCloud CLI for Node.js

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.

Prerequisites

The following software is required to work with SuiteCloud CLI for Node.js:

  • Node.js version 12.14.0 LTS or greater
  • Java 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.X.X 2020.1

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

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:setup Sets up an account to use with the SuiteCloud CLI for Node.js.
config:proxy Configures a proxy server.
file:import Imports files from an account to your account customization project.
file:list Lists the files in the File Cabinet of your 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 Overwrite the custom objects in the project with the custom objects in 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:validate Validates the folder containing the SuiteCloud project.
suitecommerce:localserver Generates a local server of your SuiteCommerce extensions and themes.

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

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 2020.1 NetSuite's release notes and documentation, check the following sections of NetSuite's Help Center:

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) 2020 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0.

Install

npm i @oracle/suitecloud-cli

DownloadsWeekly Downloads

74

Version

1.0.4

License

UPL-1.0

Unpacked Size

537 kB

Total Files

182

Last publish

Collaborators

  • avatar
  • avatar