Command-Line Interface User Guide

Command-Line Interface (CLI) of webOS Open Source Edition (OSE). It provides a collection of commands used for creating, packaging, installing, and launching apps or services in the command line environment. CLI lets you develop and test apps or services without using any IDE.

Key Features

CLI provides the following key features:

App and Service Creation
- Provides standard templates for webOS OSE apps and services
- Provides a list of available templates
- Generates an app or a service and configures basic information
App and Service Packaging
- Packages the source code and generates a package file (.ipk) to run on the target device
- Provides a feature to exclude sample and test code directories from an app or a service
Target Device Management
- Provides a list of target devices
- Adds, modifies, and removes target devices
App and Service Installation
- Installs the app and service on the target device
- Provides a list of apps installed on the target device
- Removes selected apps from the target device
App Launching and Closing
- Launches selected apps
- Closes apps that are running
- Provides the list of apps running on the target device
App and Service Debugging
- Enables Web Inspector for debugging web apps
- Enables Node’s Inspector for debugging JavaScript services
- Provides web app information
- Provides JavaScript service information
- Shows or saves logs of webOS OSE apps and services

System Requirements

Operating Systems

Required version for each operating system are as follows:

OS	Requirement
Linux	Ubuntu 18.04 LTS 64-bit
macOS	Mac OS X 10.13 High Sierra or higher
Windows	Windows 10 64-bit

Software Tools

Node.js (Use v8.12.0 to v14.15.1.)
npm

Installing CLI

You can install CLI using the following command. It is recommended to install CLI globally.

$ npm install -g @webosose/ares-cli

# Check the installation.
$ ares --version
Version: 2.x.x

Note

For Linux and macOS, sudo command might be required depending on the environment.
After the installation, check if the installed version matches with the latest version of CLI npm package.

CLI Workflow

webOS OSE CLI provides features for developing web apps throughout the whole development process. The figure below shows some of CLI commands that can be used during each stage of the development process.

Note
For step-by-step instructions to create web apps and JS service using CLI commands, see Creating Web Apps and Creating JS Services.

CLI Commands

The following table shows the available CLI commands.

Commands	Descriptions
ares	Provides the help menu for using the `ares` commands.
ares-generate	Creates a webOS OSE app or service from templates.
ares-package	Packages the app or services into a package file.
ares-setup-device	Manages the target devices.
ares-install	Installs the app or service on the target device.
ares-launch	Launches or terminates the app.
ares-log	Shows or saves logs of webOS OSE apps or services.
ares-inspect	Enables Web Inspector or Node's Inspector for debugging web app or JS service.
ares-server	Runs the Web server for testing local app file.
ares-shell	Executes shell commands in the target device.
ares-push	Pushes file(s) from a host machine to a target device.
ares-pull	Pulls file(s) from a target device to a host machine.
ares-device	Displays the device information.

ares

This command provides the help menu for using the ares commands.

History

Version	Changes
v1.6.4	Added in.

Usages

ares

ares [OPTION...]

Options

Option	Parameter	Description
-l, --list	None	Lists all the `ares` commands.
--[COMMAND]	None	Displays the help menu of `COMMAND`. `COMMAND` is entered using postfix of the `ares` commands. For more details, see Examples.
-h, --help	None	Displays this help menu.
-V, --version	None	Displays the version of the CLI.
-v	None	Displays the execution log.

Examples

Here are some examples of the different uses:

Listing all the ares commands
```
ares -l
```
Displaying the help menu for the ares-install command.
```
ares --install
```

ares-generate

This command creates a webOS OSE app or service from a template. ares-generate displays a list of available templates for a web app, JS services, and webOS OSE configuration files.

History

Version	Changes
v2.1.0	Updates `requiresPermissions` in the `appinfo.json` file. Caution Template files generated by CLI v2.0.3 or older are not compatible with webOS OSE 2.10.0 or higher.
v1.11.0	Updates the properties of the `appinfo.json` file.
v1.6.4	Added in.

Version

Changes

v2.1.0

Updates requiresPermissions in the appinfo.json file.

Caution
Template files generated by CLI v2.0.3 or older are not compatible with webOS OSE 2.10.0 or higher.

v1.11.0

Updates the properties of the appinfo.json file.

v1.6.4

Added in.

Usages

ares-generate [OPTION...] APP_DIR

ares-generate [OPTION...] -t js_service SERVICE_DIR

ares-generate --list|-l

ares-generate --version|-V

ares-generate --help|-h

Options

Option

Parameter

Description

-t, --template

TEMPLATE

Uses the specified template. Available templates are:

Template Name	Brief Description
webapp	(Default) web app template for webOS
hosted_webapp	Hosted web app template for webOS
webappinfo	Creates an `appinfo.json` file for web apps.
js_service	JS service template for webOS
jsserviceinfo	Creates a `services.json` and `package.json` file for JS services.
icon	Creates an app icon file. [80x80]
qmlapp	QML app template for webOS
qmlappinfo	Creates an `appinfo.json` for QML app.

-p, --property

PROPERTY

Sets the properties of webOS OSE configuration files.

-s, --servicename

SERVICE_NAME

Specifies the JS Service ID.

-f, --overwrite

None

Allows overwriting of existing files.

-l, --list

None

Lists the available templates. See description of the -t option above.

-h, --help

None

Displays the help of the ares-generate command

-V, --version

None

Displays the version of the CLI.

-v

None

Displays the execution log.

Parameters

Parameter	Description
APP_DIR	Specifies the app directory. If the directory does not exist, the directory will be created while executing the command.
SERVICE_DIR	Specifies the service directory. If the specified directory does not exist, the directory will be created while executing the command.
PROPERTY	Specifies the app information. It is entered using JSON-type strings in the format of `"key=value"` or `"{'key1':'value1', 'key2':'value2', ...}"`.
TEMPLATE	Specifies the template to use when creating an app or a service. The default value is `webapp`.
SERVICE_NAME	ID of the service you are creating. The service ID should be a sub-domain of the ID of the app which the service belongs to.

Examples

Here are some examples of the different uses:

Listing the templates (web application templates)
```
ares-generate -l
```
Creating a web application with the default template in ./sampleApp directory
```
ares-generate sampleApp
```
Creating a web application with a custom app ID in ./sampleApp directory
```
ares-generate -p "id=com.example.sampleapp" sampleApp
```
Creating a JS Service with a custom service ID in ./sampleService directory
```
ares-generate -t js_service -s com.example.sampleapp.sampleservice sampleService
```
Note
The service ID should be a sub-domain of the ID of the app which the service belongs to.

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

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

ares-package

This command packages an app and a JS service into a package file (.ipk) which is stored in a specified directory.

History

Version	Changes
v1.12.0	Stops to support Enyo features.
v1.6.4	Added in.

Usages

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

ares-package --version|-V

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 package file. If `appinfo.json` file does not exist, warning messages appear.
-e, --app-exclude	EX_DIR	Lists the directories to exclude in the package file.
-r, --rom	None	Proceeds up to the stage just before creating package file phase.
-h, --help	None	Displays the help of the `ares-package` command.
-V, --version	None	Displays the version of the CLI.
-v	None	Displays the execution log.

Parameters

Parameter	Description
APP_DIR	Specifies the directory where the application's `appinfo.json` file is located.
SERVICE_DIR	Specifies the directory where the service's `services.json` file is located.
OUT_DIR	Specifies the directory where the package file is to be created. If the directory is not entered, 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 directories used for samples and tests. All subdirectories and files in the specified directory are excluded. And specified files also are excluded. To exclude multiple directories, enter as `-e subdir -e filename`. You can use common pattern expression such as wildcard (*).

Examples

Here are some examples of the 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 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 an external JS service
```
ares-package sampleApp sampleService
```
Creating a package file with multiple external JS services
```
ares-package sampleApp sampleServiceA sampleServiceB
```

Creating a package file with an external JS service (using absolute path)

# Windows
ares-package c:\samples\sampleApp c:\samples\sampleService

#Linux/MacOS
ares-package ~/samples/sampleApp ~/samples/sampleService

ares-setup-device

This command displays a list of registered target devices. You can add, modify, or remove them from the list. This command is mainly used to modify target’s host address which is running on a remote host. If you execute the command without any options, the command runs in interactive mode.

History

Version	Changes
v2.2.0	Updates a naming rule for the `DEVICE_NAME` parameter.
v1.12.0	Supports the `--default` option.
v1.6.4	Added in.

Usages

ares-setup-device

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

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

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

ares-setup-device [OPTION...] --default|-f [TARGET_NAME]

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.
-f, --default	TARGET_NAME	Sets a default target device. If you don't set a target device, the default target device is used as the target device.
-R, --reset	None	Initializes the list of registered target devices.
-l, --list	None	Lists registered target devices.
-F, --listfull	None	Lists registered target devices' information with more detail (JSON string).
-h, --help	None	Displays the help of the `ares-setup-device` command.
-V, --version	None	Displays the version of the CLI.
-v	None	Displays the execution log.

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 The target device name should consist of letters, numbers, hyphen (`-`), underscore (`_`), and number sign (`#`) and start with letters or underscore (`_`). 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. password: Password for authenticating the root user. By default the password for root user is blank. If the password was previously set for a root user, then enter it here. privatekey: Filename of SSH private key. Not applicable to the root user. For the device, do not enter anything, leave it blank. The value will be auto-generated by using the passphrase provided by the user. passphrase: Passphrase for using the SSH private key file. default: Setting a default device. Enter `true` to set a default device. Default value is `false`. This key must be used with `--add` option. When using CLI in interactive mode, take care when entering the required values or choosing to use the default values, otherwise you might not be able to use the device.
TARGET_NAME	Specifies the name of the target device.

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
- The target device name should consist of letters, numbers, hyphen (-), underscore (_), and number sign (#) and start with letters or underscore (_).
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.
password: Password for authenticating the root user.
- By default the password for root user is blank.
- If the password was previously set for a root user, then enter it here.
privatekey: Filename of SSH private key.
- Not applicable to the root user.
- For the device, do not enter anything, leave it blank. The value will be auto-generated by using the passphrase provided by the user.
passphrase: Passphrase for using the SSH private key file.
default: Setting a default device.
- Enter true to set a default device. Default value is false.
- This key must be used with --add option.

When using CLI in interactive mode, take care when entering the required values or choosing to use the default values, otherwise you might not be able to use the device.

TARGET_NAME

Specifies the name of the target device.

The following example shows a DEVICE_INFO written in JSON format:

"{'host':'127.0.0.1', 'port':'22'}"

Examples

Here are some examples of the different uses:

Listing target devices

ares-setup-device --list

name               deviceinfo               connection  profile
------------------ ------------------------ ----------- -------
emulator (default) developer@127.0.0.1:6622 ssh         ose

Listing all details of target devices

ares-setup-device --listfull

[
    {
        "profile": "rpi",
        "name": "device",
        "deviceinfo": {
            "ip": "127.0.0.1",
            "port": "22",
            "user": "root"
        },
        "connection": [
            "ssh"
        ],
        "details": {
            "platform": "webos",
            "password": "",
            "description": "webOS Open Device"
        }
    }
]

Adding the target device as a default device (target device name: target, host address: 10.123.45.67, port number: 22, user: root)
```
ares-setup-device --add target -i "host=10.123.45.67" -i "port=22" -i "username=root" -i "default=true"
```
Adding the target device with JSON format (target device name: target, host address: 10.123.45.67, port number: 22, user: root)
```
ares-setup-device --add target --info "{'host':'10.123.45.67', 'port':'22', 'username':'root', 'default':true}"
```

Adding the target device with interactive mode (target device name: target, host address: 10.123.45.67, port number: 22, user: root)

ares-setup-device

name               deviceinfo               connection  profile
------------------ ------------------------ ----------- -------
emulator (default) developer@127.0.0.1:6622 ssh         ose

** You can modify the device info in the above list, or add a new device.
? Select: add
? Enter Device Name: target
? Enter Device IP address: 10.123.45.67
? Enter Device Port: 22
? Enter ssh user: root
? Enter description: sample
? Select authentication: password
? Enter password: [hidden]
? Set default? Yes
? Save? Yes

name               deviceinfo               connection profile
------------------ ------------------------ ---------- -------
target (default)   root@10.123.45.67:22     ssh        ose
emulator           developer@127.0.0.1:6622 ssh        ose

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

Modifying the target device (target device name: target, port number: 9922)
```
ares-setup-device --modify target -i "port=9922"
```

Modifying the target device with interactive mode (target device name: target, port number: 9922)

ares-setup-device

name               deviceinfo               connection profile
------------------ ------------------------ ---------- -------
target (default)   root@10.123.45.67:22     ssh        ose
emulator           developer@127.0.0.1:6622 ssh        ose

** You can modify the device info in the above list, or add a new device.
? Select: modify
? Enter Device Name: target
? Enter Device IP address: 10.123.45.67
? Enter Device Port: 9922
? Enter ssh user: root
? Enter description: sample
? Select authentication: password
? Enter password: [hidden]
? Save? Yes

name             deviceinfo               connection profile
---------------- ------------------------ ---------- -------
target (default) root@10.123.45.67:9922   ssh        ose
emulator         developer@127.0.0.1:6622 ssh        ose

Note
If you want to keep the previous value, press the enter key without any value.

Setting the default device (target device name: target)
```
ares-setup-device --default target
```
Removing the target device (target device name: target)
```
ares-setup-device --remove target
```
Note
To remove or set a target device, you only need to enter the name of the target device following the command.

ares-install

This command 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.

History

Version	Changes
v1.6.4	Added in.

Usages

ares-install [OPTION...] PKG_FILE

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

ares-install [OPTION...] --list|-l

ares-install [OPTION...] --listfull|-F

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. Unless specified, it will be set to the default target device.
-l, --list	None	Lists the installed apps on the specified target device. Use this option in conjunction with `-d`, `--device` option.
-F, --listfull	None	Lists installed applications with more detail. Use this option in conjunction with `-d`, `--device` option.
-D, --device-list	None	Lists all the available devices.
-r, --remove	APP_ID	Removes the specified app from the device.
-h, --help	None	Displays the help of the `ares-install` command.
-V, --version	None	Displays the version of the CLI.
-v	None	Displays the execution log.

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.

Examples

Here are some examples of the different uses:

Listing available target devices
```
ares-install --device-list
```

Installing the app on the target device

ares-install --device target com.example.sampleapp_1.0.0_all.ipk

Listing apps which are installed on the target device
```
ares-install --device target --list
```

Removing the app from the target device

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

ares-launch

This command launches or terminates the application installed on the target device. This command can also display the list of applications running on the target device.

History

Version	Changes
v1.12.0	Supports the `--hosted` option.
v1.11.0	Supports the `--display` option.
v1.6.4	Added in.

Usages

ares-launch [OPTION...] APP_ID

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

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

ares-launch --device-list|-V

ares-launch --version|-V

ares-launch --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device. Unless specified, it will be set to the default target device.
--close	APP_ID	Terminates application on the target device.
-r, --running	None	Lists applications that are running on the target device.
-p, --params	PARAMS	Launches an application with specified parameters.
-dp, --display	DISPLAY_ID	Launches an application on a specified display.
-D, --device-list	None	Lists all the available devices.
-H, --hosted	APP_DIR	Runs an app without installation
-h, --help	None	Displays the help of the `ares-launch` command.
-V, --version	None	Displays the version of the CLI.
-v	None	Displays the execution log.

Parameters

Parameter	Description
APP_ID	ID of the application to launch or terminate.
APP_DIR	Working directory of an app. If `--hosted` option is used with a directory path, an app (ID: `com.sdk.ares.hostedapp`) is launched on the target device. The launched opens the files in the `APP_DIR` directory. To close this app, use `--close` option with `com.sdk.ares.hostedapp` as an `APP_ID`.
DISPLAY_ID	ID of the display to launch an app. It should be an integer type. (Use `0` for primary display and `1` for secondary display.)
TARGET_DEVICE	Specifies the target device on which the application is installed.
PARAMS	Specifies the parameters which are used on application launching. It is entered using JSON-type strings in the format `"{'param1':'value1', 'param2':'value2 which contains spaces', ...}"`.

Examples

Here are some examples of the different uses:

Launching the application installed on the target device
```
ares-launch --device target com.example.sampleapp
```
Launching the application with URL parameter
```
ares-launch --device target com.example.sampleapp --params "{'url':'webosose.org'}"
```
Note
When you use a parameter, the web app will receive the parameter with the webOSLaunch event. For more detailed information on the webOSLaunch event, see Web App Lifecycle.

Launching the application on the primary display

ares-launch --device target com.example.sampleapp --display 0

Listing applications running on the target device
```
ares-launch --device target --running
```

Terminating application currently running

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

Terminating application on the primary display

ares-launch --device target --close com.example.sampleapp --display 0

Running the app without installation

ares-launch --device target --hosted sampleApp

ares-log

This command shows and saves logs of webOS OSE apps and services using journald. For more details on journald, see Viewing Logs when journald is Enabled.

History

Version	Changes
v2.2.0	Added in.

Usages

ares-log [OPTION...] 

ares-log [OPTION...] --follow|-f

ares-log [OPTION...] --reverse|-r

ares-log [OPTION...] --lines|-n LINE

ares-log [OPTION...] --boot|-b

ares-log [OPTION...] --dmesg|-k

ares-log [OPTION...] --priority|-p PRIORITY

ares-log [OPTION...] --pid|-pid PID

ares-log [OPTION...] --since|-S DATE

ares-log [OPTION...] --until|-U DATE

ares-log [OPTION...] --unit-list|-ul

ares-log [OPTION...] --unit|-u UNIT

ares-log [OPTION...] --file-list|-fl

ares-log [OPTION...] --file|-f JOURNAL_FILE

ares-log --device-list|-D

ares-log --version|-V

ares-log --help|-h

Options

Option	Parameter	Description
-o, --output	OUTPUT_MODE	Changes logs to the specified format. Must use with the options outputting logs.
-s, --save	SAVED_FILE	Saves logs to the file. Must use with the options outputting logs.
-dp, --display	DISPLAY_ID	Selects the display to check logs. Must use with the `unit` and `unit-list` options.
-d, --device	TARGET_DEVICE	Specifies the target device. Unless specified, it will be set to the default target device.
-D, --device-list	None	Lists all the available devices.
-h, --help	None	Displays the help of the `ares-log` command.
-V, --version	None	Displays the version of the CLI.
-v	None	Displays the execution log.

Parameters

Parameter	Description
LINE	Number of lines.
PRIORITY	Priority level of logs. For more details on available `PRIORITY` values, see Filter Messages by Priority.
PID	Process ID to check logs.
DATE	Timestamp in the format: `YYYY-MM-DD hh:mm:ss`.
UNIT	Unit name to check logs. To get the list of available `UNIT` values, use the `--unit-list` option.
JOURNAL_FILE	Journal file name. To get the list of available `JOURNAL_FILE` values, use the `--file-list` option.
OUTPUT_MODE	Format of log messages. For more details, see Format Logs.
SAVED_FILE	File name or path to save logs.
DISPLAY_ID	ID of the display to check logs. It should be an integer type. (Use 0 for primary display and 1 for secondary display.)
TARGET_DEVICE	Specifies the target device for saving or showing logs.

Examples

Here are some examples of the different uses:

Following the journals.
```
ares-log -f -d DEVICE
```
Displaying the number of journal entries to show.
```
ares-log -n 10 -d DEVICE
```

Displaying logs between the two DATEs.

ares-log -S 2021-03-18 21:38:00 --until 2021-03-18 21:39:00 -d DEVICE

Displaying a list of the stored journal files.
```
ares-log -fl -d DEVICE
```
Displaying stored logs from system.journal in the JSON format.
```
ares-log -file system.journal -o json -d DEVICE
```
Displaying logs of the specified process ID and saving them to a log file.
```
ares-log -pid 1735 -s pid_1735.log -d DEVICE
```
Displaying logs of the specified unit.
```
ares-log -u sam -d DEVICE
```

ares-inspect

This command enables Web Inspector or Node’s Inspector. Each inspector displays the run-time information of a web application or a JS service, respectively.

Caution

We highly recommend you to use the same version as Chrome/Chromium of webOS OSE. Using other versions might cause unexpected errors.

To check the Chromium version of your target device, do one of the following:
- Execute the ares-device -i command. In this case, make sure username of the target device is set as root. Otherwise the Chromium version won’t be displayed. For more details, see DEVICE_INFO of ares-setup-device.
- Execute the Web Browser app and go to http://useragentstring.com.
- Visit the webOS OSE GitHub and find a Chromium repository of the latest version. Then see src/chrome/VERSION file.
To download old builds of Chrome/Chromium, visit the Chromium Project website.

History

Version	Changes
v2.0.2	Supports the `--display` option.
v1.6.4	Added in.

Usages

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

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

ares-inspect --device-list|-D

ares-inspect --version|-V

ares-inspect --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device. Unless specified, it will be set to the default target device.
-a, --app	APP_ID	Specifies the application to debug with Web Inspector.
-s, --service	SERVICE_ID	Specifies the JS service to debug with Node's Inspector.
-o, --open	None	Opens the default browser of the host machine. Note This option is only available for Web Inspector, thus can be used with `--app\|-a` option only. Web Inspector works in the Blink-based web browsers (e.g. Chrome or Opera) only. You have to re-open the inspector page in one of those browsers if another browser is your default web browser (e.g. Safari or Internet Explorer). To connect to Node's Inspector, you need to use one of the Node's Inspector clients, such as Chrome DevTools and Visual Studio Code. For more information, see Inspector Clients.
-D, --device-list	None	Lists all the available devices.
-dp, --display	DISPLAY_ID	Launches an application and opens Web Inspector on a specified display.
-h, --help	None	Displays the help of the `ares-inspect` command.
-V, --version	None	Displays the version of the CLI.
-v	None	Displays the execution log.

Parameters

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

Examples

Here are some examples of the different uses:

Running the Web Inspector for an application

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

Running the Node’s Inspector for a JS service

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

ares-server

This command runs a web server for testing a local file. The web server will run on the given path. You can terminate the web server by pressing Control+C on the shell prompt.

History

Version	Changes
v1.6.4	Added in.

Usages

ares-server [OPTION...] APP_DIR

ares-server --version|-V

ares-server --help|-h

Options

Option	Parameter	Description
-p, --port	PORT	Specifies the port to be used. (Default: random)
-o, --open	None	Opens the default browser of the host machine.
-h, --help	None	Displays the help of the `ares-server` command.
-V, --version	None	Displays the version of the CLI.
-v	None	Displays the execution log.

Parameters

Parameter	Description
APP_DIR	Specifies the directory where the application's `appinfo.json` file is located.

Examples

Here are some examples of the different uses:

Running the web server in a source directory
```
ares-server ./source
```
Running the web server with a browser
```
ares-server ./source --open
```

ares-shell

This command opens a shell of a target device and executes shell commands in the target device.

History

Version	Changes
v1.6.4	Added in.

Usages

ares-shell -d TARGET_DEVICE

ares-shell -d TARGET_DEVICE -r CMD

ares-shell --device-list|-D

ares-shell --version

ares-shell --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device. Unless specified, it will be set to the default target device.
-r, --run	CMD	Specifies a command executed in the target device.
-D, --device-list	None	Lists available target devices.
-h, --help	None	Displays the help of the `ares-shell` command.
-V, --version	None	Displays the version of the CLI.
-v	None	Displays the execution log.

Parameters

Parameter	Description
CMD	Specifies a command executed in the target device.
TARGET_DEVICE	Specifies the target device on which the shell is executed.

Examples

Here are some examples of the different uses:

Opening the remote shell of the target device
```
ares-shell --device target
```

Executing a command inside the shell of the target device

ares-shell --device target -r "pwd"

ares-shell --device target -r "echo hello webOS"

ares-push

This command pushes file(s) from a host machine to a target device.

History

Version	Changes
v1.6.4	Added in.

Usages

ares-push [OPTION...] SOURCE DESTINATION

ares-push --device-list|-D

ares-push --version|-V

ares-push --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device that you want to copy the file(s) to. Unless specified, it will be set to the default target device.
-D, --device-list	None	Lists available target devices.
-h, --help	None	Displays the help of the `ares-push` command.
-V, --version	None	Displays the version of the CLI.
-i, --ignore	None	Does not display detailed messages of the `ares-push` result.
-v	None	Displays the execution log.

Parameters

Parameter	Description
SOURCE	Specifies the file/directory path of the host machine.
DESTINATION	Specifies the file/directory path of the target device.
TARGET_DEVICE	Specifies the target device that you want to copy the file(s) to.

Examples

Here are some examples of the different uses:

Listing available targets
```
ares-push --device-list
```
Pushing contents of a specific directory from the host machine to the target device
```
ares-push --device target <hostPath>/tmpDir <targetPath>/tmpDir
```

Pushing a file from the host machine to the target device

ares-push --device target <hostPath>/foo.txt <targetPath>/foo.txt

ares-pull

This command pulls file(s) from a target device to a host machine.

History

Version	Changes
v1.6.4	Added in.

Usages

ares-pull [OPTION...] SOURCE DESTINATION

ares-pull --device-list|-D

ares-pull --version|-V

ares-pull --help|-h

Options

Option	Parameter	Description
-d, --device	TARGET_DEVICE	Specifies the target device that you want to copy the file(s) from. Unless specified, it will be set to the default target device.
-D, --device-list	None	Lists available target devices.
-h, --help	None	Displays the help of the `ares-pull` command.
-V, --version	None	Displays the version of the CLI.
-i, --ignore	None	Does not display detailed messages of the `ares-pull` result.
-v	None	Displays the execution log.

Parameters

Parameter	Description
SOURCE	Specifies the file/directory path of the target device.
DESTINATION	Specifies the file/directory path of the host machine.
TARGET_DEVICE	Specifies the target device that you want to copy the file(s) from.

Examples

Here are some examples of the different uses:

Listing available target devices
```
ares-pull --device-list
```
Pulling contents of a specific directory from the target device to the host machine
```
ares-pull --device target <targetPath>/tmpDir <hostPath>/tmpDir
```

Pulling a file from the target device to the host machine

ares-pull --device target <targetPath>/foo.txt <hostPath>/foo.txt

ares-device

This command displays the information of the target device.

History

Version	Changes
v2.1.0	Supports screen capture using the `--capture-screen` option.
v2.0.0	`ares-device-info` is replaced by `ares-device`.
v1.13.0	Added in.

Usages

ares-device [OPTION...] [TARGET_DEVICE]

ares-device --device-list|-D

ares-device --version|-V

ares-device --help|-h

Options

Option	Parameter	Description
-i, --system-info	None	Displays the device system information.
-s, --session-info	None	Displays the device session information. Note This option is not supported in webOS OSE.
-c, --capture-screen	OUTPUT_PATH	Capture screen and save the file to the host machine.
-dp, --display	DISPLAY_ID	Specify DISPLAY_ID. Use it with capture screen option.
-d, --device	TARGET_DEVICE	Specifies the target device. Unless specified, it will be set to the default target device.
-D, --device-list	None	Lists all the available devices.
-h, --help	None	Displays the help of the `ares-device` command.
-V, --version	None	Displays the version of the CLI.
-v	None	Displays the execution log.

Parameters

Parameter	Description
TARGET_DEVICE	Specifies the target device. Unless specified, it will be set to the default target device.
OUTPUT_PATH	Specifies the file/directory path of the host machine to save captured file.
DISPLAY_ID	ID of the display to be captured. It should be an integer type. (Use `0` for primary display and `1` for secondary display.)

Examples

Here are some examples of the different uses:

Displaying the system information of the target device (target device name: target)
```
ares-device --system-info --device target
```

Capture the display 1 as screen.png (target device name: target)

ares-device --capture-screen screen.png --display 1 --device target