From abad011d4ae42cc7714eb62012cd16eedce01e2c Mon Sep 17 00:00:00 2001 From: wusongqing Date: Wed, 16 Mar 2022 17:02:55 +0800 Subject: [PATCH 1/2] Added English docs Signed-off-by: wusongqing --- .../ability/ability-assistant-guidelines.md | 103 ++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 en/application-dev/ability/ability-assistant-guidelines.md diff --git a/en/application-dev/ability/ability-assistant-guidelines.md b/en/application-dev/ability/ability-assistant-guidelines.md new file mode 100644 index 00000000000..5474fd39aad --- /dev/null +++ b/en/application-dev/ability/ability-assistant-guidelines.md @@ -0,0 +1,103 @@ +# Ability Assistant Usage + +The ability assistant enables you to start applications, atomic services, and test cases and debug applications. By using this tool, you can send commands in the hdc shell to perform various system operations, such as starting abilities, forcibly stopping processes, and printing ability information. + +## Development Guidelines + +The ability assistant is pre-installed in the device environment. You can directly invoke the tool using commands. + +### Query-related Commands + +- **help** + + Displays the help information about the ability assistant. + + **Return value** + + Returns the help information. + + **Method** + + ``` + aa help + ``` + +### Ability-related Commands + +- **start** + + Starts an ability. + + | Name| Description| + | --------- | ---------------------- | + | -h/--help | Help information.| + | -d | Device ID. This parameter is optional.| + | -a | Ability name. This parameter is mandatory.| + | -b | Bundle name. This parameter is mandatory.| + | -D | Debugging mode. This parameter is optional.| + + **Return value** + + Returns "start ability successfully." if the ability is started; returns "error: failed to start ability." otherwise. + + **Method** + + ``` +aa start [-d ] -a -b [-D] + ``` + +- **stop-service** + + Stops a Service ability. + + | Name| Description| + | --------- | ------------------------ | + | -h/--help | Help information.| + | -d | Device ID. This parameter is optional.| + | -a | Ability name. This parameter is mandatory.| + | -b | Bundle name. This parameter is mandatory.| + + **Return value** + + Returns "stop service ability successfully." if the Service ability is stopped; returns "error: failed to stop service ability." otherwise. + + **Method** + + ``` +aa stop-service [-d ] -a -b + ``` + +- **dump** + + Prints ability related information. + + | Name| Description| + | ---------------------- | -------------------------------------- | + | -h/--help | Help information.| + | -a/--all | Ability information in all missions.| + | -s/--stack \ | Ability information in a specified mission stack.| + | -m/--mission \ | Ability information in a specified mission.| + | -l/--stack-list | Mission list in each mission stack.| + | -u/--ui | System UI ability information.| + | -e/--serv | Service ability information.| + | -d/--data | Data ability information.| + + **Method** + + ``` + aa dump -a + ``` + +- **force-stop** + + Forcibly stops a process based on the bundle name. + + **Return value** + + Returns "force stop process successfully." if the process is forcibly stopped; returns "error: failed to force stop process." otherwise. + + **Method** + + ``` + aa force-stop + ``` -- Gitee From 7e6acad57a073a016f6fd87d2d473181d744a6f0 Mon Sep 17 00:00:00 2001 From: wusongqing Date: Wed, 16 Mar 2022 17:06:14 +0800 Subject: [PATCH 2/2] Added English docs Signed-off-by: wusongqing --- .../ability/ability-assistant-guidelines.md | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/en/application-dev/ability/ability-assistant-guidelines.md b/en/application-dev/ability/ability-assistant-guidelines.md index 5474fd39aad..b51a23aa461 100644 --- a/en/application-dev/ability/ability-assistant-guidelines.md +++ b/en/application-dev/ability/ability-assistant-guidelines.md @@ -28,13 +28,13 @@ The ability assistant is pre-installed in the device environment. You can direct Starts an ability. - | Name| Description| + | Name | Description | | --------- | ---------------------- | - | -h/--help | Help information.| - | -d | Device ID. This parameter is optional.| + | -h/--help | Help information. | + | -d | Device ID. This parameter is optional. | | -a | Ability name. This parameter is mandatory.| - | -b | Bundle name. This parameter is mandatory.| - | -D | Debugging mode. This parameter is optional.| + | -b | Bundle name. This parameter is mandatory. | + | -D | Debugging mode. This parameter is optional. | **Return value** @@ -43,19 +43,19 @@ The ability assistant is pre-installed in the device environment. You can direct **Method** ``` -aa start [-d ] -a -b [-D] + aa start [-d ] -a -b [-D] ``` - **stop-service** Stops a Service ability. - | Name| Description| + | Name | Description | | --------- | ------------------------ | - | -h/--help | Help information.| - | -d | Device ID. This parameter is optional.| + | -h/--help | Help information. | + | -d | Device ID. This parameter is optional. | | -a | Ability name. This parameter is mandatory.| - | -b | Bundle name. This parameter is mandatory.| + | -b | Bundle name. This parameter is mandatory. | **Return value** @@ -64,23 +64,23 @@ aa start [-d ] -a -b [-D] **Method** ``` -aa stop-service [-d ] -a -b + aa stop-service [-d ] -a -b ``` - **dump** Prints ability related information. - | Name| Description| + | Name | Description | | ---------------------- | -------------------------------------- | - | -h/--help | Help information.| - | -a/--all | Ability information in all missions.| - | -s/--stack \ | Ability information in a specified mission stack.| - | -m/--mission \ | Ability information in a specified mission.| + | -h/--help | Help information. | + | -a/--all | Ability information in all missions. | + | -s/--stack \ | Ability information in a specified mission stack. | + | -m/--mission \ | Ability information in a specified mission. | | -l/--stack-list | Mission list in each mission stack.| - | -u/--ui | System UI ability information.| - | -e/--serv | Service ability information.| - | -d/--data | Data ability information.| + | -u/--ui | System UI ability information. | + | -e/--serv | Service ability information. | + | -d/--data | Data ability information. | **Method** -- Gitee