@webos-tools/cli 3.0.0

package/files/conf-base/template-conf/ose-templates.json

@@ -0,0 +1,67 @@
+{
+    "webapp": {
+        "type": "webapp",
+        "path": "$cli-root/files/templates/ose-sdk-templates/bootplate-web",
+        "description": "web app for webOS",
+        "metadata": {
+            "id": "webappinfo"
+        },
+        "deps": [
+            "icon"
+        ],
+        "default": true
+    },
+    "hosted_webapp": {
+        "type": "webapp",
+        "path": "$cli-root/files/templates/ose-sdk-templates/hosted-webapp",
+        "description": "hosted web app for webOS",
+        "metadata": {
+            "id": "webappinfo"
+        },
+        "deps": [
+            "icon"
+        ]
+    },
+    "webappinfo": {
+        "type": "webappinfo",
+        "path": "$cli-root/files/templates/ose-sdk-templates/appinfo/appinfo.json",
+        "description": "appinfo.json for web app"
+    },
+    "js_service": {
+        "type": "jsservice",
+        "path": "$cli-root/files/templates/ose-sdk-templates/js-service",
+        "description": "js service for webOS",
+        "metadata": {
+            "id": "jsserviceinfo"
+        }
+    },
+    "jsserviceinfo": {
+        "type": "jsserviceinfo",
+        "path": [
+            "$cli-root/files/templates/ose-sdk-templates/serviceinfo/services.json",
+            "$cli-root/files/templates/ose-sdk-templates/serviceinfo/package.json"
+        ],
+        "description": "services.json, package.json for JS service"
+    },
+    "icon": {
+        "type": "icon",
+        "path": "$cli-root/files/templates/ose-sdk-templates/icon",
+        "description": "app icon files [80x80]"
+    },
+    "qmlapp": {
+        "type": "qmlapp",
+        "path": "$cli-root/files/templates/ose-sdk-templates/qml-app",
+        "description": "QML app for webOS",
+        "metadata": {
+            "id": "qmlappinfo"
+        },
+        "deps": [
+            "icon"
+        ]
+    },
+    "qmlappinfo": {
+        "type": "qmlappinfo",
+        "path": "$cli-root/files/templates/ose-sdk-templates/qmlappinfo/appinfo.json",
+        "description": "appinfo.json for QML app"
+    }
+}

package/files/conf-base/template-conf/tv-sdk-templates.json

@@ -0,0 +1,57 @@
+{
+    "basic": {
+        "type": "webapp",
+        "path": "$cli-root/files/templates/tv-sdk-templates/bootplate-web",
+        "description": "basic web app for webOS TV",
+        "metadata": {
+            "id": "webappinfo"
+        },
+        "deps": [
+            "webicon"
+        ],
+        "default": true
+    },
+    "hosted_webapp": {
+        "type": "webapp",
+        "path": "$cli-root/files/templates/tv-sdk-templates/hosted-webapp",
+        "description": "hosted web app for webOS TV",
+        "metadata": {
+            "id": "webappinfo"
+        },
+        "deps": [
+            "webicon"
+        ]
+    },
+    "webappinfo": {
+        "type": "webappinfo",
+        "path": "$cli-root/files/templates/tv-sdk-templates/appinfo/appinfo.json",
+        "description": "appinfo.json for web app"
+    },
+    "js_service": {
+        "type": "jsservice",
+        "path": "$cli-root/files/templates/tv-sdk-templates/js-service",
+        "description": "js service for webOS TV",
+        "metadata": {
+            "id": "jsserviceinfo"
+        }
+    },
+    "jsserviceinfo": {
+        "type": "jsserviceinfo",
+        "path": [
+            "$cli-root/files/templates/tv-sdk-templates/serviceinfo/services.json",
+            "$cli-root/files/templates/tv-sdk-templates/serviceinfo/package.json"
+        ],
+        "description": "services.json, package.json for JS service"
+    },
+    "webicon": {
+        "type": "icon",
+        "path": "$cli-root/files/templates/tv-sdk-templates/webicon",
+        "description": "web app icon files [80x80, 130x130]",
+        "hide": true
+    },
+    "packageinfo": {
+        "type": "packageinfo",
+        "path": "$cli-root/files/templates/tv-sdk-templates/packageinfo/packageinfo.json",
+        "description": "packageinfo.json for webOS package"
+    }
+}

package/files/help/ares-config.help

@@ -0,0 +1,43 @@
+{
+    "display" : ["name", "synopsis", "options", "description", "examples"],
+    "notab":["examples"],
+    "name" : "ares-config - Configure webOS CLI",
+    "synopsis" : {
+        "default" : [
+            "ares-config [OPTION...]"
+        ]
+    },
+        "description" : [
+        {
+          "default" : [
+            "This command used for configuring the webOS devices profile setting to work with CLI.",
+            "",
+            "DEVICE_PROFILE is the profile of a target device.",
+            "This parameter can be \"ose\" and \"tv\". \"tv\" is default."
+          ],
+          "ose" : [
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ]
+        }
+    ],
+    "examples" : [
+        "# Configure profile for platform (ose)",
+        "ares-config -p ose",
+        "",
+        "# Currently configured profile",
+        "ares-config -c",
+        ""
+    ],
+    "options" : {
+        "cmdOpt":"option",
+        "default" : ["profile", "profile-details", "help", "version", "verbose"],
+        "ose" : ["level"],
+        "profile" : "-p, --profile <DEVICE_PROFILE> @TAB@ Specify a device profile to configure for CLI",
+        "profile-details" : "-c, --profile-details @TAB@ Display current configured profile",
+        "help" : "-h, --help @TAB@ Display this help",
+        "version" : "-V, --version @TAB@ Display version info",
+        "verbose" : "-v @TAB@ Display this verbose log",
+        "level" : "--level <LEVEL> @TAB@ Set log LEVEL and display log as set LEVEL"
+    }
+}

package/files/help/ares-device.help

@@ -0,0 +1,94 @@
+{
+    "display" : ["name", "synopsis", "options", "extraoption", "description", "examples"],
+    "notab":["examples"],
+    "notitle" : ["extraoption"],
+    "name" : "ares-device - Display the device information",
+    "synopsis" : {
+        "default" : [
+            "ares-device",
+            "ares-device [OPTION...]"
+        ]
+    },
+    "description" : {
+        "default": [
+            "This command displays the device information or monitor resource usage.",
+            "",
+            "ID is an ID of the app or service whose resource usage will be displayed.",
+            "",
+            "CSV_FILE is a file name or path to save the resource usage data.",
+            "The file format can be only \".csv\"."
+        ],
+        "ose" : [
+            "",
+            "And This command supports screen capture.",
+            "",
+            "CAPTURE_FILE is file name or file path of capture file.",
+            "The file format can be \".png\", \".jpg\" and \".bmp\". \".png\" is default.",
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+        ]
+    },
+    "options" : {
+        "cmdOpt":"option",
+        "default" : ["system", "resource", "list", "id-filter", "interval", "save"],
+        "ose" : ["capture", "display", "device", "device-list", "help", "version", "verbose", "level"],
+        "tv" : ["device", "device-list", "help", "version", "verbose"],
+        "system" : "-i, --system-info @TAB@ Display the system information",
+        "session" : "-se, --session-info @TAB@ Display the session information",
+        "resource" : "-r, --resource-monitor @TAB@ Monitor resource usage",
+        "list" : [
+            "    -l, --list @TAB@ Monitor resource usage of running apps and services",
+            "@TAB@ Use it with --resource-monitor"
+        ],
+        "id-filter" : [
+            "    -id, --id-filter <ID> @TAB@ Show resource usage of an app or service",
+            "@TAB@ Use it with --resource-monitor"
+        ],
+        "interval" : [
+            "    -t, --time-interval @TAB@ Set the monitoring interval (seconds)",
+            "@TAB@ Use it with --resource-monitor"
+        ],
+        "save" : [
+            "    -s, --save <CSV_FILE> @TAB@ Save resource usage data to CSV_FILE",
+            "@TAB@ Use it with --resource-monitor"
+        ],
+        "capture" : "-c, --capture-screen <CAPTURE_FILE> @TAB@ Capture screen and save the file to the host machine",
+        "display" : [
+            "-dp,--display <DISPLAY_ID> @TAB@ Specify DISPLAY_ID",
+            "@TAB@ Use it with capture screen option"
+        ],
+        "device" : [
+            "-d, --device <DEVICE> @TAB@ Specify DEVICE to use",
+            "@TAB@ If not specified, set to default device"
+        ],
+        "device-list" : "-D, --device-list @TAB@ List the available DEVICEs",
+        "help" : "-h, --help @TAB@ Display this help",
+        "version" : "-V, --version @TAB@ Display version info",
+        "verbose" : "-v @TAB@ Display this verbose log",
+        "level" : "--level <LEVEL> @TAB@ Set log LEVEL and display log as set LEVEL"
+    },
+    "examples" : {
+        "default" : [
+            "# Display system information",
+            "ares-device -i -d DEVICE",
+            "",
+            "# Display resource usage",
+            "ares-device -r -d DEVICE",
+            "",
+            "# Display resource usage periodically and save them to a CSV file",
+            "ares-device -r -s resouce.csv -t 1 -d DEVICE",
+            "",
+            "# Display resource usage of running apps and services",
+            "ares-device -r -l -t 3 -d DEVICE",
+            "",
+            "# Display resource usage of specified running app",
+            "ares-device -r -id com.examples.app -t 5 -d DEVICE",
+            ""
+        ],
+        "ose" : [
+            "# Capture the screen of display 1 as screen.png",
+            "ares-device -c screen.png -dp 1 -d DEVICE",
+            ""
+        ]
+    }
+}

package/files/help/ares-generate.help

@@ -0,0 +1,65 @@
+{
+    "display" : ["name", "synopsis", "options", "extraoption", "description", "examples"],
+    "notitle": ["extraoption"],
+    "notab":["examples", "extraexamples"],
+    "name" : "ares-generate - Generate files for a webOS app or service",
+    "synopsis" : {
+        "default" : [
+            "ares-generate [OPTION...] <APP_DIR>"
+        ]
+    },
+    "description" : [
+        {
+          "default" : [
+            "This command generates files from the template.",
+            "",
+            "APP_DIR is the app directory. It will be created if it does not exist.",
+            "",
+            "PROPERTY defines properties to be used during generation",
+            "Properties can be specified as key-value pairs of the form \"key=value\"",
+            "or as JSON objects of the form \"{'key':'value', 'key2':'value2', ...}\".",
+            "Surrounding quotes are required in both cases."
+          ],
+          "ose" : [
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ]
+        }
+    ],
+    "examples" : [
+        {
+            "default" : [
+                "# Create a webOS app in ~/project/app and set the id, version, title",
+                "ares-generate -t webapp -p \"{'id':'com.domain.app', 'version':'1.0.0', 'title':'First App'}\" ~/projects/app",
+                " Or",
+                "ares-generate -t webapp -p \"id=com.domain.app\" -p \"version=1.0.0\" -p \"title=First App\" ~/projects/app",
+                "",
+                "# Create a webOS service named 'com.domain.app.service'",
+                "ares-generate -t js_service -s \"com.domain.app.service\" ~/projects/service",
+                ""
+            ]
+        }
+    ],
+    "options" : {
+        "cmdOpt":"option",
+        "default" : ["template", "list", "property", "servicename", "overwrite", "help", "version", "verbose"],
+        "ose" : ["level"],
+        "template" : [
+            "-t, --template <TEMPLATE> @TAB@ Use the template named TEMPLATE"
+        ],
+        "list" : [
+            "-l, --list @TAB@ List the available templates"
+        ],
+        "property" : [
+            "-p, --property <PROPERTY> @TAB@ Set the properties of appinfo.json, services.json or packageinfo.json"
+        ],
+        "servicename" : [
+            "-s, --servicename <SERVICE_NAME> @TAB@ Set the servicename for webOS service"
+        ],
+        "overwrite" : "-f, --overwrite @TAB@ Overwrite existing files",
+        "help" : "-h, --help @TAB@ Display this help",
+        "version" : "-V, --version @TAB@ Display version info",
+        "verbose" : "-v @TAB@ Display this verbose log",
+        "level" : "--level <LEVEL> @TAB@ Set log LEVEL and display log as set LEVEL"
+    }
+}

package/files/help/ares-inspect.help

@@ -0,0 +1,70 @@
+{
+    "display" : ["name", "synopsis", "options", "extraoption", "description", "examples", "extraexample"],
+    "notitle": ["extraoption", "extraexample"],
+    "notab":["examples", "extraexample"],
+    "name" : {
+        "ose" : "ares-inspect - Enable Web Inspector or Node's Inspector for webOS web app or service",
+        "tv" : "ares-inspect - Provide URL to use Remote Web Inspector or Node Inspector"
+    },
+    "synopsis" : {
+        "default" : [
+            "ares-inspect [OPTION...] [-a, --app] <APP_ID>",
+            "ares-inspect [OPTION...] -s, --service <SERVICE_ID>"
+        ]
+    },
+    "description" : [
+        {
+          "default" : [
+            "This command launches Web Inspector for APP_ID or Node's Inspector for SERVICE_ID.",
+            "",
+            "APP_ID is an app id described in appinfo.json.",
+            "SERVICE_ID is a service id described in services.json."
+          ],
+          "ose" : [
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ]
+        }
+    ],
+    "options" : {
+        "cmdOpt":"option",
+        "default" : ["open", "device", "device-list", "help", "version", "verbose"],
+        "ose" : ["display", "level"],
+        "open" : "-o, --open @TAB@ Open url with a web browser",
+        "device" : [
+            "-d, --device <DEVICE> @TAB@ Specify DEVICE to use",
+            "@TAB@ If not specified, set to default device"
+        ],
+        "device-list" : "-D, --device-list @TAB@ List the available DEVICEs",
+        "display": "-dp,--display <DISPLAY_ID> @TAB@ Launches Inspector on the specified display",
+        "help" : "-h, --help @TAB@ Display this help",
+        "version" : "-V, --version @TAB@ Display version info",
+        "verbose" : "-v @TAB@ Display this verbose log",
+        "level" : "--level <LEVEL> @TAB@ Set log LEVEL and display log as set LEVEL"
+    },
+    "extraoption" : {
+        "cmdOpt":"hidden",
+        "default" : {
+            "cmdOpt":"option",
+            "default" : ["host-port", "level"],
+            "host-port" : "-P, --host-port @TAB@ Specify Host PC's port for remote Web/Node's Inspector"
+        }
+    },
+    "examples" : {
+        "default": [
+            "# Display URL to use Web Inspector for debugging a web app",
+            "ares-inspect com.yourdomain.app -d DEVICE",
+            "",
+            "# Display URL or guide text to use Node's Inspector for debugging a JS service",
+            "ares-inspect -s com.yourdomain.app.service -d DEVICE"
+        ]
+    },
+    "extraexample" : {
+        "cmdOpt" : "hidden",
+        "default" : [
+            "# Use 2043 port on the host pc for the remote Web Inspector",
+            "ares-inspect com.yourdomain.app -d DEVICE -P 2043",
+            ""
+        ]
+    }
+}

package/files/help/ares-install.help

@@ -0,0 +1,90 @@
+{
+    "display" : ["name", "synopsis", "options", "extraoption", "description", "examples", "extraexample"],
+    "notab":["examples", "extraexample"],
+    "notitle" : ["extraoption", "extraexample"],
+    "name" : "ares-install - Install or remove the app on the device",
+    "synopsis" : {
+        "default" : [
+            "ares-install [OPTION...] <PACKAGE_FILE>",
+            "ares-install [OPTION...] -r, --remove <APP_ID>"
+        ]
+    },
+    "description" : [
+        {
+          "default" : [
+            "This command installs or removes packages on the DEVICE.",
+            "",
+            "PACKAGE_FILE is a webOS package with .ipk extension."
+          ],
+          "ose" : [
+            "",
+            "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+          ]
+        }
+    ],
+    "examples" : [
+        {
+            "default" : [
+                "# Remove an app on the DEVICE",
+                "ares-install -r com.examples.app -d DEVICE",
+                "",
+                "# List the applications installed on the DEVICE",
+                "ares-install -l -d DEVICE",
+                "",
+                "# Install a package on the DEVICE",
+                "ares-install ~/projects/packages/com.examples.app_1.0_all.ipk -d DEVICE"
+            ]
+        }
+    ],
+    "options" : {
+        "cmdOpt":"option",
+        "default" : ["device", "device-list", "list", "listfull", "type", "help", "version", "verbose"],
+        "ose" : ["level"],
+        "device" : [
+            "-d, --device <DEVICE> @TAB@ Specify DEVICE to use",
+            "@TAB@ If not specified, set to default device"
+        ],
+        "device-list" : "-D, --device-list @TAB@ List the available DEVICEs",
+        "list" : "-l, --list @TAB@ List the installed apps",
+        "listfull" : "-F, --listfull @TAB@ List the detailed info of the installed apps",
+        "help" : "-h, --help @TAB@ Display this help",
+        "version" : "-V, --version @TAB@ Display version info",
+        "verbose" : "-v @TAB@ Display this verbose log",
+        "level" : "--level <LEVEL> @TAB@ Set log LEVEL and display log as set LEVEL"
+    },
+    "extraoption" : {
+        "cmdOpt":"hidden",
+        "default" : {
+            "cmdOpt":"option",
+            "default" : ["type", "opkg", "opkg-param", "level"],
+            "type" : "-t, --type <TYPE> @TAB@ Specify TYPE as one of 'web', 'native' for the app list",
+            "opkg" : "-o, --opkg @TAB@ Use opkg tool for installing/removing an ipk package",
+            "opkg-param" : [
+                "-op, --opkg-param <PARAMS> @TAB@ parameters for opkg tool",
+                "@TAB@ this option is available only for the device allowing root-connection"
+            ]
+        }
+    },
+    "extraexample" : {
+        "cmdOpt" : "hidden",
+        "default" : [
+            "# List the installed web apps on the DEVICE",
+            "ares-install <PACKAGE_FILE> -d DEVICE -l -t web",
+            "",
+            "# List the installed native apps on the DEVICE",
+            "ares-install <PACKAGE_FILE> -d DEVICE -l -t native",
+            "",
+            "# Install .ipk by 'opkg install' instead of the installd",
+            "ares-install <PACKAGE_FILE> -d DEVICE --opkg",
+            "",
+            "# Remove .ipk by 'opkg remove' instead of the installd",
+            "# (Note.) To remove a package by opkg command, <PACKAG_NAME> should be specified instead of <APP_ID>",
+            "# (Note.) Please refer to 'ares-package --hidden-help', it provides '--pkgname' option for making .ipk",
+            "ares-install -r <PACKAGE_NAME> -d DEVICE --opkg",
+            "",
+            "# Install .ipk by 'opkg install' with parameters",
+            "ares-install <PACKAGE_FILE> -d DEVICE --opkg --opkg-param \"-o /media/developer/apps\"",
+            ""
+        ]
+    }
+}

package/files/help/ares-launch.help

@@ -0,0 +1,100 @@
+{
+    "display" : ["name", "synopsis", "options", "extraoption", "description", "examples", "extraexample"],
+    "notab":["examples", "extraexample"],
+    "notitle" : ["extraoption", "extraexample"],
+    "name" : "ares-launch - Launch or close the app",
+    "synopsis" : {
+        "default" : [
+            "ares-launch [OPTION...] <APP_ID>"
+        ],
+        "tv" : [
+            "ares-launch -H, --hosted <APP_DIR> [-I, --host-ip <HOST_IP>]",
+            "ares-launch -s, --simulator <WEBOS_TV_VERSION> <APP_DIR> [-sp, --simulator-path <SIMULATOR_PATH>] [OPTION...]"
+          ]
+    },
+    "description" : {
+        "default" : [
+        "This command launches or closes apps on the DEVICE.",
+        "",
+        "APP_ID is an app id described in appinfo.json.",
+        "",
+        "PARAMS can be acquired from 'window.PalmSystem.launchParams' of the web app.",
+        "",
+        "APP_DIR is the app's working directory.",
+        "If 'hosted' option is used with the directory path",
+        "an app with id 'com.sdk.ares.hostedapp' is launched on the DEVICE",
+        "and it opens the files in the directory.",
+        "To close this app, use com.sdk.ares.hostedapp as APP_ID."
+        ],
+        "ose" : [
+        "",
+        "LEVEL is priority of logs. (e.g., silly, verbose, info, warn, error)"
+        ],
+        "tv" : [
+        "",
+        "If 'hosted' option does not work with network connection error,",
+        "specify the host's IP address with 'host-ip' option.",
+        ""
+        ]
+    },
+    "options" : {
+        "cmdOpt":"option",
+        "default" : ["running", "close", "params"],
+        "ose" : ["hosted", "display", "device", "device-list", "help", "version", "verbose", "level"],
+        "tv" : ["device", "device-list", "help", "version", "verbose"],
+        "device" : [
+            "-d, --device <DEVICE> @TAB@ Specify DEVICE to use",
+            "@TAB@ If not specified, set to default device"
+        ],
+        "device-list" : "-D, --device-list @TAB@ List the available DEVICEs",
+        "close" : "-c, --close <APP_ID> @TAB@ Close a running app",
+        "running" : "-r, --running @TAB@ List the running apps",
+        "params" : "-p, --params <PARAMS> @TAB@ Launch/Close an app with the specified parameters",
+        "display" : "-dp,--display <DISPLAY_ID> @TAB@ Launch/Close an app on the specified display",
+        "hosted" : "-H, --hosted <APP_DIR> @TAB@ Runs only an app without installation",
+        "help" : "-h, --help @TAB@ Display this help",
+        "version" : "-V, --version @TAB@ Display version info",
+        "verbose" : "-v @TAB@ Display this verbose log",
+        "level" : "--level <LEVEL> @TAB@ Set log LEVEL and display log as set LEVEL"
+    },
+    "examples" : {
+        "default" : [
+            "# Launch an app on the DEVICE",
+            "ares-launch com.examples.app -d DEVICE",
+            "",
+            "# Close an app on the DEVICE",
+            "ares-launch -c com.examples.app -d DEVICE",
+            "",
+            "# Launch an app with parameters",
+            "ares-launch com.examples.app -p \"{'data1':'foo', 'data2':'bar'}\" -d DEVICE",
+            " Or",
+            "ares-launch com.examples.app -p \"data1=foo\" -p \"data2=bar\" -d DEVICE",
+            "",
+            "# Run an app without installation",
+            "ares-launch -H APP_DIR -d DEVICE"
+        ],
+        "tv" : [
+            "",
+            "# Run an app without installation using HOST_IP",
+            "ares-launch -H APP_DIR -I 192.168.0.10 -d DEVICE",
+            "",
+            "# Run an app on the webOS TV 22 simulator",
+            "ares-launch -s 22 APP_DIR",
+            "",
+            "# Run an app on the webOS TV 22 simulator located on SIMULATOR_PATH",
+            "ares-launch -s 22 -sp /home/webOS_TV_22_Simulator_1.3.0 APP_DIR",
+            "",
+            "# Run an app on the simulator with parameters",
+            "ares-launch -s 22 APP_DIR -p \"{'data1':'foo', 'data2':'bar'}\"",
+            " Or",
+            "ares-launch -s 22 APP_DIR -p \"data1=foo\" -p \"data2=bar\""
+        ]
+    },
+    "extraexample" : {
+        "cmdOpt" : "hidden",
+        "tv" : [
+            "# Run an app without installation using HOST_IP",
+            "ares-launch -H APP_DIR -I 192.168.0.10 -d DEVICE"
+        ]
+    }
+}