CLI Introduction

The webOS TV 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 using a specific IDE.

CLI features

With the webOS TV CLI, you can install your apps on a target device, such as the simulator, emulator, or webOS TV device. 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:

The development process with the CLI

Commands

The following table 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 and analyses 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 and monitors the device's resource usage.
ares-extend-dev Extends the session time of the developer mode for the Developer Mode app.

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

Examples

Here are some examples of CLI usage:

  • Listing bootplates (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_SDKCLIsampleApp
    Success
    
  • Creating a web app with a custom app ID in the ./sampleApp directory

    ares-generate -p "id=com.example.sampleapp" sampleApp
    
    Generating basic in C:webOS_TV_SDKCLIsampleApp
    Success
    
  • Creating a web app with the hosted web app template in the ./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_SDKCLIsampleApp
    Success
    
  • Creating a JS service with a custom service ID in the ./sampleService directory. Note that the service ID must be a sub-domain of the ID of the app to which the service belongs.

    ares-generate -t js_service -s com.example.sampleapp.sampleservice sampleService
    
  • Creating a web app in the ./sampleApp directory and setting properties with JSON strings

    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 your app and JS service into a package file (.ipk) stored in a specified directory. With the info or info-detail option, you can check the information about the package file.

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.

important

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 -i, --info PACKAGE_FILE
ares-package -I, --info-detail PACKAGE_FILE
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 your app'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.
-i, --info PACKAGE_FILE Specifies the file with the .ipk extension to be analyzed.
-I, --info-detail PACKAGE_FILE Specifies the file with the .ipk extension to be analyzed in detail.
-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 your app 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 JS 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. Note that 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 your app when packaging the package file. You must enter the directories used for samples and tests. All subdirectories and files in the specified directory are excluded. Besides, specified files are excluded. This command finds directories and file recursively from the app 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 (*).
PACKAGE_FILE Specifies the file with the .ipk extension to be analyzed.
note

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 the ./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 files (.txt)

    ares-package -e "testCode1" -e "README.md" -e "*.txt" samplePrj
    
  • Creating a package file with a external JS service directory

    ares-package sampleApp sampleService
    
  • Analyzing a package file

    ares-package -i ./com.examples.app_1.0.0_all.ipk
    
  • Analyzing a package file in more detail

    ares-package -I ./com.examples.app_1.0.0_all.ipk
    

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 [OPTIONS...] -f, --default [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 a target device.
-r, --remove TARGET_NAME Deletes a target device.
-f, --default TARGET_NAME Sets a target device as default.
-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 the 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 a 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 a 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 a 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
    
    note

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

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

    ares-setup-device --modify sampleEmulator -i "port=9922"
    
  • Modifying a 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!!
    
    note

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

  • Removing a target device (Target device name: sampleEmulator)

    ares-setup-device --remove sampleEmulator
    
  • Searching webOS devices

    ares-setup-device --search
    
  • Setting a device as default

    ares-setup-device -f DEVICE
    

ares-install

Installs your app for a specified app package file (.ipk) on a 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 --device-list|-D
ares-install --version|-V
ares-install --help|-h

Options

Option Parameter Description
-d, --device TARGET_DEVICE Specifies a target device on which your app should be installed.
-l, --list [-t, --type option] Lists the installed apps on a specified target device. Use this option in conjunction with -d, --device option.
-F, --listfull [-t, --type option] Lists installed apps 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.
note

storage-list and storage options have been deprecated since the CLI v1.12.0.

Parameters

Parameter Description
PKG_FILE Specifies the path of your app package file.
APP_ID ID of an app to remove from the device.
TARGET_DEVICE Specifies a target device for installing or removing an 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

Examples

Here are some examples of CLI usages:

  • Listing available target devices

    ares-install --device-list
    
  • Installing the app that the package name is com.example.sampleapp_0.0.1_all.ipk 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 app type

    ares-install --device emulator --list --type web
    
  • Removing the app that the app ID is com.example.sampleapp from the emulator

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

ares-launch

Runs or terminates an app installed on a 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|-c APP_ID
ares-launch [OPTION...] --running|-r
ares-launch [OPTION...] --simulator|-s WEBOS_TV_VERSION APP_DIR
ares-launch --device-list|-D
ares-launch --version|-V
ares-launch --help|-h

Options

Option Parameter Description
-d, --device TARGET_DEVICE Specifies a target device where you install your app.
-H, --hosted APP_DIR Runs your app without installation. However, With this option, you cannot execute the app that includes JS services. For more information, see Debugging Web App.
-I, --host-ip HOST_IP Specifies a host's IP address. You must use this option with the --hosted option. The host IP for the --hosted option is selected automatically by default. However, specify the host's IP address with this option if the --hosted option does not work properly due to a network connection error.
-c, --close APP_ID Terminates an app on the target device.
-r, --running None Lists apps that are running on the target device.
-s, --simulator WEBOS_TV_VERSION Specifies the webOS TV version of the simulator to be launched. For more information, see Debugging Web App.
-p, --params PARAMS Launches an app with specified parameters.
--device-list None Lists all the available target devices.
-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 Specify the ID of an app to run or terminate.
TARGET_DEVICE Specifies the target device on which the app is installed.
WEBOS_TV_VERSION Specifies the webOS TV version of the simulator on which the app is tested.
APP_DIR Specifies the app's working directory to be tested.
HOST_IP Specifies the host's IP address.
PARAMS Specifies parameters which are used on app launching. You should enter parameters and values 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 that the ID is com.example.sampleapp 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'}"
    
    note

    When you use a parameter, the 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 that ID is com.example.sampleapp on the emulator

    ares-launch --device emulator --close com.example.sampleapp
    
  • Running the app without installation in the sampleApp directory

    ares-launch --device emulator --hosted sampleApp
    
  • Running the app in the sampleApp directory without app installation using the host IP address 192.168.0.10 on the emulator

    ares-launch --device emulator --hosted sampleApp --host-ip 192.168.0.10
    
  • Running the app in the sampleApp directory on the webOS TV 22 simulator

    ares-launch -s 22 sampleApp
    
  • Running the app in the sampleApp directory with two parameters on the simulator

    ares-launch -s 22 APP_DIR -p "{'data1':'foo', 'data2':'bar'}"
    
    ares-launch -s 22 APP_DIR -p "data1=foo" -p "data2=bar"
    

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 your web app or JS service.

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 a target device where you install your app.
-a, --app APP_ID Specifies an app to run with Web Inspector.
-s, --service SERVICE_ID Specifies a 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 an app whose information is to be viewed using Web Inspector.
SERVICE_ID ID of a JS service whose information is to be viewed using Node Inspector.
TARGET_DEVICE Specifies a target device where you install your app.

Examples

Here are some examples of different usages:

  • Running Web Inspector for the app that the ID is com.example.sampleapp

    ares-inspect --device emulator --app com.example.sampleapp
    
  • Running Node Inspector for the JS service that the ID is com.example.sampleapp.sampleservice

    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 macOS).

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 an app that you publish 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 --device emulator --forward --port 6622:3030
    
  • Running the 'ps aux' command on webOS TV named tv

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

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. With the resource-monitor option, you can monitor CPU (%) and memory (KB) usage of the target device or running apps and services.

Usages

ares-device-info
ares-device-info [OPTION...]
ares-device-info [OPTION...] --resource-monitor|-r
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.
-r, --resource-monitor None Monitors resource usage of the target device.
-l, --list None Monitors resource usage of running apps and services. Use this option with the --resource-monitor option.
-id, --id-filter ID Use this option with the --resource-monitor option.
-t, --time-interval TIME_INTERVAL Sets the monitoring interval in seconds. Use this option with the --resource-monitor option.
-s, --save CSV_FILE Specifies the file name or path to save the resource usage data. Use this option with the --resource-monitor option.
--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.
ID Specifies the ID of the app or service whose resource usage is displayed.
TIME_INTERVAL Specifies the time interval for monitoring resource usage in seconds.
CSV_FILE Specifies a file name or path to save the resource usage data. The file can be the .csv format only.

Examples

Here are some examples of CLI usages:

  • Listing available target devices

    ares-device-info --device-list
    
  • Retrieving a 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
    
  • Displaying the resource usage

    ares-device-info -d Device -r
    
  • Displaying the resource usage periodically and saving the data into a CSV file

    ares-device-info -d DEVICE -r -s resource.csv -t 1
    
  • Displaying the resource usage by running apps and services

    ares-device-info -d DEVICE -r -l
    
  • Displaying the resource usage by the specified running app every three seconds

    ares-device-info -d DEVICE -r -id com.example.app -t 3
    

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
    
No Headings