Introduction

The CLI (Command Line Interface) provides a collection of commands used for creating, packaging, installing, and launching web apps in the command line environment. The CLI allows you to develop and test your app without having to use a specific IDE.

CLI Features

With the CLI, you can install your app on a target device, such as the emulator or webOS TV. Besides, you can retrieve, run, terminate, and remove the apps installed on the target device. You can use the CLI during any of the following stages of the development process:

Commands

The following shows the commands you could use:

Commands	Descriptions
ares	Provides the help menu for using the ares commands
ares-generate	Creates a web app from a template.
ares-package	Creates an app package file.
ares-setup-device	Manages the target devices.
ares-install	Installs an app on the target device.
ares-launch	Runs or terminates the web app.
ares-inspect	Runs the Web Inspector for web app debugging.
ares-server	Runs the Web server for testing local app files.
ares-novacom	Gets a private key from webOS TV for the Developer Mode app.
ares-device-info	Retrieves a device's system information.
ares-extend-dev	Extends the session time of the developer mode for the Developer Mode app.

Open All

ares-generate

Creates an app from a template.

The ares-generate command displays a list of available templates for a web app, JS service, and webOS config file (appinfo.json).

Usages

ares-generate [OPTION...] APP_DIR|SERVICE_DIR

ares-generate --list|-l

ares-generate --version

ares-generate --help|-h

Options

Option	Parameter	Description
-t, --template	TEMPLATE	Uses the specified template.
-p, --property	PROPERTY	Saves the application information that is entered.
-s, --servicename	SERVICE_NAME	Specifies the JS Service ID.
-f, --overwrite	None	Allows overwriting of existing files.
-l, --list	None	Lists templates of each template type.
-v	None	Displays the execution log.
-V, --version	None	Displays the version of the ares-generate command.
-h, --help	None	Displays the help of the ares-generate command

Parameters

Parameter	Description
APP_DIR	Specifies the app project directory. If the directory does not exist, the directory is created while executing the command.
SERVICE_DIR	Specifies the service directory. If the specified directory does not exist, the directory is created while executing the command.
PROPERTY	Specifies the app information. You should entere this parameter using JSON-type strings in the format of "Key=Value" or "{'key1':'value1', 'key2':'value2', ...}".
TEMPLATE	Specifies the template to use when creating a project.
SERVICE_NAME	The ID of the service you are creating. The service ID must be a sub-domain of the ID of the app to which the service belongs.

Examples

Here are some examples of CLI usage:

Listing the bootplate (web app templates)

ares-generate -l

basic          Web App          -  (default) basic web app for webOS TV
hosted_webapp  Web App          -  hosted web app for webOS TV
webappinfo     Web App Info     -  appinfo.json for web app
js_service     JS Service       -  js service for webOS TV
jsserviceinfo  JS Service Info  -  services.json, package.json for JS service
packageinfo    Package Info     -  packageinfo.json for webOS package

Creating a web app with the default template

ares-generate sampleApp

? app id com.example.sampleapp
? title Sample App
? version 0.0.1
Generating basic in C:\webOS_TV_SDK\CLI\sampleApp
Success

Creating a web app with custom App ID in ./sampleApp directory

ares-generate -p "id=com.example.sampleapp" sampleApp

Generating basic in C:\webOS_TV_SDK\CLI\sampleApp
Success

Creating a web app with the hosted web app template in ./sampleApp directory

ares-generate -t hosted_webapp sampleApp

? app id com.example.hostedapp
? title Hosted App
? version 0.0.1
? url http://webostv.hostedapp.lge.com
Generating hosted_webapp in C:\webOS_TV_SDK\CLI\sampleApp
Success

Creating a JS Service with custom Service ID in ./sampleService directory

ares-generate -t js_service -s com.example.sampleapp.sampleservice sampleService

The service ID must be a sub-domain of the ID of the app to which the service belongs.

Creating a web app in the ./sampleApp and setting properties with JSON string

ares-generate -p "{'id':'com.example.sampleapp', 'version':'0.0.1', 'icon':'icon.png', 'type':'web', 'title':'Sample App', 'main':'index'}" sampleApp

ares-package

Packages the app and JS service into a package file (.ipk) stored in a specified directory.

The packaging process has two phases: minifying source code and creating a package file. The ares-package command reduces the size of source code by getting rid of as much redundant code as possible and merges it when creating a package file. The ares-package command adjusts and shrinks the variable names and line spacing. It also merges multiple files into a single file to reduce source code size and file load time.

An error occurs if an app file name contains non-ASCII characters. App file names must contain Latin letters ONLY.

Usages

ares-package [OPTION...] APP_DIR [SERVICE_DIR] [PKG_DIR]

ares-package --version

ares-package -help|-h

Options

Option	Parameter	Description
-o, --outdir	OUT_DIR	Specifies a directory where the package file is created.
-c, --check	None	Checks whether the application's appinfo.json file exists or not. This option does not make a package file. If the appinfo.json file does not exist, warning messages appear.
-e, --app-exclude	EX_DIR	Lists the directories to exclude in the package file.
-n, --no-minify	None	Skips the process of minifying the source code.
-r, --rom	None	Proceeds up to the stage just before creating a package file phase.
-v	None	Displays the execution log.
-V, --version	None	Displays the version of the ares-package command.
-h, --help	None	Displays the help of ares-package command.

Parameters

Parameter	Description
APP_DIR	Specifies the directory of the application to be packaged.
SERVICE_DIR	Specifies the directory where JS Service's package.json file is located.
PKG_DIR	Specifies the directory where the packageinfo.json file existed. The file is a metadata file that contains information used by the packaging tool and the system. In general, you do not need to create the packageinfo.json file unless you include JavaScript services into your app package. If there is no specified PKG_DIR, the ares-package command makes the packageinfo.json file from the appinfo.json file. If you use your packageinfo.json file, keep the data rule, such as ID naming conventions in the appinfo.json file.
OUT_DIR	Specifies the directory where the package file is to be created. If you do not enter the directory, the package file is created in the same directory as the command.
EX_DIR	Specifies the name of directories and files to exclude from the application when packaging the package file. You should enter the directories used for samples and tests. All subdirectories and files in the specified directory are excluded. Besides, specified files are excluded. Command finds directories and file recursively from the application directory that is matched. To exclude multiple directories, enter as "-e subdir -e filename.” you can also use a common pattern expression such as wildcard (*).

The ares-package command recognizes SERVICE_DIR and PKG_DIR automatically by the configuration file. There is no order between the SERVICE_DIR and PKG_DIR.

Examples

Here are some examples of different uses:

Creating a package file from ./sampleApp directory and outputting it in the working directory

ares-package sampleApp

Creating a package file from the ./sampleApp directory and outputting it in ./output directory

ares-package -o output sampleApp

Creating a package file for debugging (without minifying source code)

ares-package --no-minify sampleApp

Creating a package file except for testCode1 sub-directory, README.md file and all text file (.txt)

ares-package -e "testCode1" -e "README.md" -e "*.txt" samplePrj

Creating a package file with external JS Service directory

ares-package sampleApp sampleService

ares-setup-device

Displays a list of registered target devices.

You can also add, modify, or remove them from the list. This command is mainly used to modify a target host address that is running on a remote host.

Usages

ares-setup-device

ares-setup-device [OPTIONS...] --add|-a [TARGET_NAME] [--info|-i [DEVICE_INFO]]

ares-setup-device [OPTIONS...] --modify|-m [TARGET_NAME] [--info|-i [DEVICE_INFO]]

ares-setup-device [OPTIONS...] --remove|-r [TARGET_NAME]

ares-setup-device --search|-s

ares-setup-device [--search|-s] --timeout|-t [TIMEOUT]

ares-setup-device --reset|-R

ares-setup-device --list|-l

ares-setup-device --listfull|-F

ares-setup-device --version|-V

ares-setup-device --help|-h

Options

Option	Parameter	Description
-a, --add	TARGET_NAME	Adds a target device with the specified information.
-m, --modify	TARGET_NAME	Modifies a target device's information. You can change the information of the target device except for its name.
-i, --info	DEVICE_INFO	Sets information for the target device.
-r, --remove	TARGET_NAME	Deletes a target device that matches the device name you enter.
-s, --search	None	Searches webOS devices in the same network with SSDP and displays the found device list. When you select a device from the device list, the IP address of the selected device is set for device information automatically.
-t, --timeout	TIMEOUT	Sets timeout value for the --search option. This option does not have to be preceded by the --search option. The default value is 5 (unit: second).
-R, --reset	None	Initializes the list of registered target devices.
-v	None	Displays the execution log.
-l, --list	None	Lists registered target devices.
-F, --listfull	None	Lists registered target devices' information with more detail (JSON string).
--version	None	Displays the version of the ares-setup-device command.
-h, --help	None	Displays the help of the ares-setup-device command.

Parameters

Parameter	Description
DEVICE_INFO	Specifies the information of the target device. It can be entered using strings in the format of "Key=Value" or JSON-type such as '{"key1":"value1", "key2":"value2", ...}'. You can use the following items as key for the target device: name: Target device name description: Target device description host: Target device host address port: Target device port number username: Username for accessing the target device. Possible values: root (default) – To be used by internal users only. developer – To access the emulator. prisoner – To connect to the TV device. password: Password for authenticating the root user. By default, the password for the root user is blank. If the password was previously set for the root user, then enter it here. Not applicable for developer and prisoner user. privatekey: File name of SSH private key. Used to authenticate developer and prisoner user. Not applicable for the root user. For the emulator, the value must be webos_emul (default value). For TV, do not enter anything, leave it blank. The value is auto-generated by using the passphrase provided by a user. passphrase: Passphrase for using the SSH private key file. Not required for developer users. Required only for prisoner users. Auto-generates the SSH private key file for the prisoner.   When using CLI in interactive mode, take care when entering the required values or choosing to use the default values, else you might not be able to use the device.
TARGET_NAME	Specifies the name of the target device.
TIMEOUT	Timeout for device searching (unit: second).

The following example shows a DEVICE_INFO written in JSON format:

{"host":"127.0.0.1", "port":"6622"}

Examples

Here are some examples of CLI usages:

Listing target devices

ares-setup-device --list

Adding the target device (Target device name: sampleEmulator, Host address: 10.123.45.67, Port number: 6622 User: developer)

ares-setup-device --add sampleEmulator -i "host=10.123.45.67" -i "port=6622" -i "username=developer"

Adding the target device with JSON format (Target device name: sampleEmulator, Host address: 10.123.45.67, Port number:6622 User: developer)

ares-setup-device --add sampleEmulator --info "{'host':'10.123.45.67', 'port':'6622', 'username':'developer'}"

Adding the target device with interactive mode (Target device name: sampleEmulator, Host address: 10.123.45.67, Port number: 6622, User: developer)

ares-setup-device

 

name deviceinfo connection Profile

-------- ------------------------ ---------- -------

emulator developer@127.0.0.1:6622 ssh tv

** You can modify the device info in the above list, or add a new device.

? Select: add

? Enter Device Name: sampleEmulator

? Enter Device IP address: 10.123.45.67

? Enter Device Port: 6622

? Enter ssh user: developer

? Enter description: sample

? Select authentification: ssh key

? Enter ssh private key filename: webOS_emul

? Enter keys passphrase:

? Save? Yes

 

name deviceinfo connection profile

-------- --------------------------- ---------- -------

emulator developer@127.0.0.1:6622 ssh tv

sampleEmulator developer@10.123.45.67:6622 ssh tv

If you want to input default value or set empty, press the enter key without any value.

Modifying the target device (Target device name: sampleEmulator, Port Number: 9922)

ares-setup-device --modify sampleEmulator -i "port=9922"

Modifying the target device with interactive mode (Target device name: sampleEmulator, Port number: 9922)

ares-setup-device

 

name deviceinfo connection profile

-------- --------------------------- ---------- -------

emulator developer@127.0.0.1:6622 ssh tv

sampleEmulator developer@10.123.45.67:6622 ssh tv

 

** You can modify the device info in the above list, or add a new device.

? Select: modify

? Enter Device Name: sampleEmulator

? Enter Device IP address: 10.123.45.67

? Enter Device Port: 6622

? Enter ssh user: developer

? Enter description: sample

? Select authentification: ssh key

? Enter ssh private key filename: webOS_emul

? Enter keys passphrase:

? Save? Yes

 

name deviceinfo connection

-------- --------------------------- ----------

emulator developer@127.0.0.1:6622 ssh

sampleEmulator developer@10.123.45.67:9922 ssh

Success to modify a device!!

If you want to keep the previous value, press Enter without any value.

Removing the target device (Target device name: sampleEmulator)

ares-setup-device --remove sampleEmulator

Searching webOS devices

ares-setup-device --search

ares-install

Installs the app for a specified app package file (.ipk) on the target device.

You can also see the list of apps installed on the target device or remove them with this command.

Usages

ares-install [OPTION...] PKG_FILE

ares-install [OPTION...] --remove APP_ID

ares-install [OPTION...] --list|-l [--type|-t APPLICATION_TYPE]

ares-install [OPTION...] --listfull|-F [--type|-t APPLICATION_TYPE]

ares-install --storage-list|-S

ares-install --device-list|-D

ares-install --version|-V

ares-install --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device on which the application should be installed.
-S, --storage-list	None	Lists storage devices such as internal storage and USB.
-s, --storage	STORAGE	Specifies the storage where you install your app on the device. If you don't specify this option, the app is installed on the internal storage of the device. You can find storage names with the --storage-list option.
-l, --list	[-t, --type option]	Lists the installed apps on the specified target device. Use this option in conjunction with -d, --device option.
-F, --listfull	[-t, --type option]	Lists installed applications with more detail. Use this option in conjunction with -d, --device option.
-t, --type	APPLICATION_TYPE	Filters corresponding app type from the list of installed apps. Use this option in conjunction with -l, --list option or -F, --listfull option.
--device-list	None	Lists all the available target devices.
-v	None	Displays the execution log.
--version	None	Displays the version of the ares-install command.
-h, --help	None	Displays the help of the ares-install command.

Parameters

Parameter	Description
PKG_FILE	Specifies the path of the app package file.
APP_ID	ID of the app to remove from the device.
TARGET_DEVICE	Specifies the target device for installing or removing the app or viewing the list of installed apps.
APPLICATION_TYPE	Specifies the app type for filtering the installed app list. The supported app type is: web: Web app type
STORAGE	Specifies the storage where you install your app on the device. You can find storage names with the --storage-list option.

Examples

Here are some examples of CLI usages:

Listing available target devices

ares-install --device-list

Installing the app on the emulator

ares-install --device emulator com.example.sampleapp_0.0.1_all.ipk

Listing apps that are installed on the emulator

ares-install --device emulator --list

Listing apps which are web application type

ares-install --device emulator --list --type web

Listing the storages in device

ares-install -S --device tv

Installing the app to the external storage (USB memory stick)

ares-install -s usb1 --device tv com.example.sampleapp_0.0.1_all.ipk

Removing the app from the emulator

ares-install --device emulator --remove com.example.sampleapp

ares-launch

Runs or terminates an app installed on the target device.

This command can also display the list of apps running on the target device.

Usages

ares-launch [OPTION...] APP_ID

ares-launch [OPTION...] --hosted|-H APP_DIR [--host-ip|-I HOST_IP]

ares-launch [OPTION...] --close APP_ID

ares-launch [OPTION...] --running|-r

ares-launch --version|-V

ares-launch --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device where the web app is installed.
-H, --hosted	APP_DIR	Runs the app without installation. With this option, however, you cannot execute the app that includes JS services.
-I, --host-ip	HOST_IP	Specifies the host's IP address. The host IP for the --hosted option is selected automatically by default. If the --hosted option does not work with a network connection error, specify the host's IP address with the --host-ip option.
-c, --close	APP_ID	Terminates the app on the target device.
-r, --running	None	Lists apps that are running on the target device.
-p, --params	PARAMS	Launches the web app with specified parameters.
-v	None	Displays the execution log.
--version	None	Displays the version of the ares-launch command.
-h, --help	None	Displays the help of the ares-launch command.

Parameters

Parameter	Description
APP_ID	ID of the app to run or terminate.
TARGET_DEVICE	Specifies the target device on which the app is installed.
HOST_IP	Specifies the host's IP address.
PARAMS	Specifies the parameters which are used on app launching. You should entere the parameter and value using JSON-type strings in the format '{"param1":"value1", "param2":"value2 which is containing spaces", ...}'.

Examples

Here are some examples of different usages:

Running the app installed on the emulator

ares-launch --device emulator com.example.sampleapp

Running the app with the URL parameter

ares-launch --device emulator com.example.sampleapp --params "{'url':'www.lge.com'}"

When you use a parameter, the web app receives the parameter with the webOSLaunch event. For more information about webOSLaunch event, see App Lifecycle.

Listing apps running on the emulator

ares-launch --device emulator --running

Terminating the app currently running

ares-launch --device emulator --close com.example.sampleapp

Running the app without installation

ares-launch --device emulator --hosted sampleApp

Running the app without installation using the host IP address

ares-launch --device emulator --hosted sampleApp --host-ip 192.168.0.10

ares-inspect

Provides Web Inspector and Node Inspector.

Web Inspector and Node Inspector run on a web browser. Each Inspector displays the running information about the web app or JS services.

Usages

ares-inspect [OPTION...] [--app|-a] APP_ID

ares-inspect [OPTION...] --service|-s SERVICE_ID

ares-inspect --version|-V

ares-inspect --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device where the app is installed.
-a, --app	APP_ID	Specifies the app to run with Web Inspector.
-s, --service	SERVICE_ID	Specifies the JS service to run with Node Inspector.
-o, --open	None	Open the webOS TV SDK bundle browser (Chromium).
-v	None	Displays the execution log.
--version	None	Displays the version of the ares-inspect command.
-h, --help	None	Displays the help of the ares-inspect command.

Parameters

Parameter	Description
APP_ID	ID of the app whose information is to be viewed using Web Inspector.
SERVICE_ID	ID of the JS service whose information is to be viewed using Node Inspector.
TARGET_DEVICE	Specifies the target device on which the app is installed.

Examples

Here are some examples of different usages:

Running Web Inspector for the app

ares-inspect --device emulator --app com.example.sampleapp

Running Node Inspector for the JS service

ares-inspect --device emulator --service com.example.sampleapp.sampleservice

ares-server

Runs a web server for testing local files.

The web server runs on the given path. You can terminate the web server with control-C (in Windows, Linux) or Command-C (in Mac OS).

Usages

ares-server [OPTION...] APP_DIR

ares-server --version|-V

ares-server --help|-h

Options

Option	Parameter	Description
-o, --open	None	Open the webOS TV SDK bundle browser (Chromium).
-v	None	Displays the execution log.
--version	None	Displays the version of the ares-server command.
-h, --help	None	Displays the help of the ares-server command.

Parameters

Parameter	Description
APP_DIR	Specifies the directory of the app to be published on the web server.

Examples

Here are some examples of different usages:

Running the web server in a source directory

ares-server ./source

Running the web server with the browser

ares-server ./source --open

ares-novacom

Gets a private key from webOS TV for the Developer Mode app.

After getting the private key, you can install and launch apps, or run a command on webOS TV.

Usages

ares-novacom [OPTION...] --forward|-f [--port|-p DEVICE_PORT1[:HOST_PORT1]][--port|-p DEVICE_PORT2]][...]

ares-novacom [OPTION...] --getkey|-k

ares-novacom [OPTION...] --run|-r DEVICE_COMMAND

ares-novacom --device|-d

ares-novacom --device-list

ares-novacom --version|-V

ares-novacom --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device on which the command is executed.
-f, --forward	List of -p, -port options	Enables port forwarding between the host PC and the target device. You can specify a port number with additional option (p-, --port option).
-p, --port	DEVICE_PORT[:HOST_PORT]	Specifies a port for port forwarding.
-k, --getkey	None	Gets the private key from webOS TV. Before using this option, you should run the Developer Mode app on your webOS TV.
-r, --run	DEVICE_COMMAND	Executes a command on the shell of the target device.
-D, --device-list	None	Lists available target devices.
-v	None	Displays the execution log.
--version	None	Displays the version of the ares-novacom command.
-h, --help	None	Displays the help of the ares-novacom command.

Parameters

Parameter	Description
DEVICE_PORT	Specifies the target device's port number for port forwarding between the host PC and the target device. If only DEVICE_PORT is specified, the host PC uses the same port number for port forwarding.
HOST_PORT	Specifies the host PC's port number for port forwarding between the host PC and the target device.
DEVICE_COMMAND	Specifies the command that runs on the shell of the target device.

Examples

Here are some examples of different usages:

Getting the private key from webOS TV named tv (Needed the Developer Mode app setting)

ares-novacom --device tv --getkey

Setting port forwarding between emulator (6622) and host PC (3030)

ares-novacom --forward --port 6622:3030 -d emulator

Running the 'ps -aux' command on webOS TV named tv

ares-novacom --run "ps -aux" -d tv

ares-device-info

Retrieves the following system information of a device.

• Model name

• SDK version

• Firmware version

• Board type

• OTA (Over The Air) ID

Note that only retrieved information is shown if this command fails to retrieve some system information.

Usages

ares-device-info

ares-device-info [OPTION...]

ares-device-info --device|-d

ares-device-info --device-list|-D

ares-device-info --version|-V

ares-device-info --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device on which the command is executed.
--device-list	None	Lists all the available devices.
-v	None	Displays the execution log.
--version	None	Displays the version of the ares-device-info command.
-h, --help	None	Displays the help of the ares-device-info command.

Parameters

Parameter	Description
TARGET_DEVICE	Specifies the target device for retrieving information of a device.

Examples

Here are some examples of CLI usages:

Listing available target devices

ares-device-info --device-list

Retrieving the device's valid system information

ares-device-info --device target

modelName: WEBOS4.0
sdkVersion: 04.00.00
firmwareVersion: 04.00.00
boardType: M16PP_ATSC_KR
otaId: HE_DTV_W18H_AFADATAA

ares-extend-dev

Extends the session time of the developer mode for the Developer Mode app.

Note that this command only works when the developer mode is on and the session time remains longer than 0 minutes. If this command does not update the session time, check your network connection or the developer mode status. DO NOT use this command on the emulator as the Developer Mode app cannot be installed on the emulator.

Usages

ares-extend-dev [OPTION...]

ares-extend-dev --device-list|-D

ares-extend-dev --version|-V

ares-extend-dev --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device on which the command is executed.
-D, --device-list	None	Lists available target devices.
-v	None	Displays the execution log.
--version	None	Displays the version of the ares-extend-dev command.
-h, --help	None	Displays the help of the ares-extend-dev command.

Parameters

Parameter	Description
TARGET_DEVICE	Specifies the target device for extending the session time of the developer mode.

Examples

Here are some examples of CLI usages:

Listing available target devices

ares-extend-dev --device-list

Extending the session time of the developer mode on webOS TV named tv

ares-extend-dev -d tv