Download and Install the CLI

Version added 07-Mar-2018| Modified 05-Sep-2018

You can download the command line interface (CLI) package of webOS Open Source Edition (OSE) from this page. This page also describes how to install the CLI on your host machine.

Starting from CLI v1.8.1, you must accept our SDK end-user license agreement (EULA) to use the CLI.
The EULA will appear when you execute any of the CLI commands. Once you accept the EULA for the CLI version, you can proceed with using the CLI. Otherwise, you will be prompted to accept the EULA for each command input.

Download

Installation

Unzipping the Package

Unzip the downloaded CLI package. After unzipping the package, you can execute the CLI commands located in the following directories.

  • Windows: ares-cli

  • Linux & macOS: ares-cli/bin

(Windows Only)

Due to recursively nested directory structure of Node.js modules used by CLI, the resulting path length may exceed the maximum path length of Windows. To prevent issues while installing and using CLI, we strongly recommend that you do the following: 

  • To unzip the package, use a program that supports file pathnames longer than 260 characters, such as 7-Zip.

  • Unzip the package under the root directory (for example, C:\ or D:\).

Setting the Directory

To make it easy to execute CLI commands, you need to add the CLI directory to the PATH environment variable.

Windows

If you unzipped the package under C:\, the CLI commands would be located in C:\ares-cli. You need to add the directory to the environment variable. 

You can create a system variable pointing to the directory and add the system variable to the PATH.

C:\> setx /m WEBOS_CLI_HOME "C:\ares-cli"
C:\> setx /m PATH "%WEBOS_CLI_HOME%;%PATH%"

Otherwise, you can add the directory to the PATH directly.

C:\> setx /m PATH "C:\ares-cli; %PATH%"

To set the PATH for current user only, remove "/m" from the commands above.

To make the changes take effect, you must restart the command prompt.

Linux & macOS

There are many ways to set the environment variable in Linux and macOS. Here, we describe the method to add the information to the .profile so that the PATH is automatically configured each time the shell is executed. We will assume that the CLI has been unzipped under the home directory.

First, open the .profile which is located in the home directory. If the file does not exist, the command will create one.

$ vi ~/.profile

Add the lines below at the end of the file.

...
# add CLI path
if [ -d "$HOME/ares-cli/bin" ]; then
  export PATH="$PATH:$HOME/ares-cli/bin"
fi

To make the changes take effect, you must execute the following command or restart the shell.

$ source ~/.profile

 


Except as noted, this content is licensed under Creative Commons Attribution 4.0 and sample code is licensed under Apache License 2.0.