Installing SuiteCloud CLI for Java

Important:

Before downloading SuiteCloud CLI for Java, read the Oracle Free Use Terms and Conditions license below.

The following license terms apply to those Programs that are not provided to You under Separate Terms.

To install SuiteCloud CLI for Java, extract the installation package so that you can then run CLI using Java.

Important:

The instance of SuiteCloud CLI for Java installed in your machine does not get updated automatically. Every time a new version of the CLI is released, you must manually update your SuiteCloud CLI for Java instance. You can download the latest version of the installation package from the link provided in the following procedure.

To install SuiteCloud CLI for Java:

  1. Create a directory where you want to install SuiteCloud CLI for Java, such as C:\javacli\ for Windows, or /javacli/ for Linux and macOS.

  2. Adjust your PATH system environment variable to include the SuiteCloud CLI for Java directory. By doing this, you are enabling the use of SuiteCloud CLI for Java from any folder in your machine.

    • Select Control Panel > System > Advanced system settings.

    • Click Environment Variables...

    • Under System variable, select the PATH variable, and click Edit...

    • Click New, enter the SuiteCloud CLI for Java directory path, and click OK.

    • In the Environment Variables window, click OK. Then, in the System Properties window, click Apply, and then OK.

    Note:

    To configure a proxy server, create the SUITECLOUD_PROXY environment variable. To be valid, the variable value must include an http or https protocol, a hostname, and a port number, for example: http://proxyurl:proxyport. After creating the variable, restart the console.

  3. Download SuiteCloud CLI for Java and extract the contents of one of the following packages to the SuiteCloud CLI for Java directory:

    To get the latest version (including minor releases), use one of the following links:

    Important:

    Your SuiteCloud CLI for Java instance is not automatically updated when a new version is released. Every time a new version of the CLI is released, use the preceding links to get the latest version of the installation package and manually update the SuiteCloud CLI for Java installed in your machine.

    The latest version of SuiteCloud CLI for Java is version 2025.1 and it is compatible with NetSuite 2024.2 and 2025.1.

    If you want to use the previous version of the CLI, use one of the following links:

    Important:

    Starting February 2025, SuiteCloud CLI for Java version 2024.1, which supports Token-Based Authentication (TBA) and OAuth 1.0, will no longer be available for new installations. If you are still using older versions of the tool, you should upgrade to the latest version as soon as possible. For more information, see Removal of OAuth 1.0 Token-Based Authentication Support in SuiteCloud SDK (SuiteAnswer ID 1019514).

    Note:

    The packages contain the JAR file and either the SuiteCloud CLI for Java bash or batch script, depending on the operating system.

    You can now use SuiteCloud CLI for Java by running the sdfcli command.

  4. For Linux and macOS computers, make the sdfcli bash file executable by running the following command from the SuiteCloud CLI for Java directory:

    chmod +x sdfcli

    You can now use SuiteCloud CLI for Java by running the sdfcli command.

    Note:

    You must have read, write, and execute access on any directory where you want to run SuiteCloud CLI for Java.

Related Topics

General Notices