@oniroproject/oniro-app 0.14.0 → 0.16.0

package/README.md

@@ -61,9 +61,20 @@ Install commands are idempotent (they skip when already present); pass `--force`
 | Command | Description |
 | --- | --- |
 | `sdk install <version> [--force] [--tmp-dir <path>]` | Download and install an OpenHarmony SDK (e.g. `6.1`). `--tmp-dir` overrides where download/extract temporaries go (see [Temporary space](#temporary-space)). |
+| `sdk install --from-archive <path> [--force] [--tmp-dir <path>]` | Install an SDK from a local `.tar.gz` instead, such as the [full SDK](#full-sdk). Only the current OS's components are unpacked, and the API level is read from them; an SDK already installed at that level is replaced only with `--force`. |
 | `sdk list [--json]` | List known SDK versions; an `*` marks installed ones. |
 | `sdk remove <api>` | Remove an installed SDK by API level (e.g. `18`, `20`). |
 
+##### Full SDK
+
+`sdk install <version>` downloads the public SDK, which leaves out system APIs (`@systemapi`). The full SDK is not on the release mirror: download an `ohos-sdk-full` archive from the [OpenHarmony daily builds](https://dcp.openharmony.cn/workbench/cicd/dailybuild/dailylist) and install it from the file:
+
+```bash
+oniro-app sdk install --from-archive ~/Downloads/version-Master_Version-OpenHarmony_7.0.0.39-…-ohos-sdk-full_7.0-Release.tar.gz
+```
+
+It lands in `<ONIRO_SDK_ROOT_DIR>/<os>/<api>` like a downloaded release, so projects with that `compileSdkVersion` build against it. Pass `--force` to replace a public SDK of the same API level, or set `ONIRO_SDK_ROOT_DIR` to a separate root to keep both.
+
 #### `cmdtools` — manage the OpenHarmony command-line tools (provides `hvigorw`, `ohpm`, `hdc`, `codelinter`)
 
 | Command | Description |
@@ -221,6 +232,45 @@ Local paths may be relative, or absolute with either slash. A device path that a
 | `--domain <domain>` | hilog domain filter (e.g. `0xD003900`). |
 | `--device <serial>` | Target device serial. |
 
+#### `logs collect` — create a diagnostic bundle
+
+```bash
+oniro-app logs collect --redact --package com.example.app
+```
+
+The command requires exactly one connected device unless `--device` (or
+`ONIRO_DEVICE_SERIAL`) selects one. It captures the current `hilog -x` buffer,
+faultlog evidence, device information, process list, and memory/thread snapshots.
+Because `hilog -x` has no duration argument, `--duration` filters recognized
+HiLog timestamps locally using device clock readings before and after the snapshot.
+If the clock or log format cannot be parsed reliably, the manifest records the
+window as unapplied, the command exits non-zero, and the full snapshot is omitted
+from the redacted archive (it remains only in the local raw bundle).
+`--pid`, `--tag`, and `--level` create an additional filtered HiLog view from the
+time-bounded records when their format can be parsed reliably. `--package`
+targets `hidumper -e --print <bundle> -n 5` for faultlog evidence.
+
+`--redact` creates a sibling `incident-...-redacted` directory and ZIP; the
+archive is built only from that redacted copy. Without `--redact`, the archive
+contains raw sensitive data. Redaction is heuristic, fails closed on binary or
+unknown-encoding files, and does not guarantee that a bundle is safe to publish.
+Collection continues after individual command failures and records each result
+in `manifest.json`; the CLI exits non-zero for a partial bundle. The default
+output is under `~/.oniro/incident-bundles`; bundle files are created with
+owner-only permissions where the host OS supports POSIX modes.
+
+| Flag | Description |
+| --- | --- |
+| `-o, --output <directory>` | Parent directory for bundles (default `~/.oniro/incident-bundles`). |
+| `--device <serial>` | Target device serial. |
+| `--package <bundle>` | Bundle name for package-specific faultlog collection. |
+| `--pid <pid>` | Create an exact-PID filtered HiLog view. |
+| `--tag <tag>` | Create an exact-tag filtered HiLog view. |
+| `--level <level>` | Create a filtered view for `V`, `D`, `I`, `W`, `E`, or `F`. |
+| `--duration <seconds>` | Include HiLog records from the last N seconds (default `600`; maximum `31536000`). |
+| `--redact` | Redact text evidence; create the archive only from the redacted copy. |
+| `--json` | Emit bundle paths and completion status as JSON. |
+
 #### `hdc` — run the bundled hdc
 
 `hdc [args...]` runs the `hdc` binary oniro-app itself uses (the one `cmdtools status` shows), with stdio passed through, so it needs nothing on `PATH`. Device commands are addressed at `--device` or `ONIRO_DEVICE_SERIAL` unless the arguments start with `-t`. `hdc --path` prints the binary's location. The exit code is hdc's own, which is 0 even for a `[Fail]` line.
@@ -539,7 +589,7 @@ oniro-app sign --apl system_core --acls ohos.permission.ACCESSIBILITY_EXTENSION_
     --app-privilege-capabilities AllowAppUsePrivilegeExtension
 ```
 
-Apps like these usually also call system APIs (`@systemapi`), which the public SDK that `sdk install` downloads leaves out: the build fails with errors such as `'config' is not exported from Kit '@kit.AccessibilityKit'`. Build them against the full OpenHarmony SDK by unpacking its components into `<root>/<os>/<api>` of a separate SDK root and pointing `ONIRO_SDK_ROOT_DIR` at that root.
+Apps like these usually also call system APIs (`@systemapi`), which the public SDK that `sdk install` downloads leaves out: the build fails with errors such as `'config' is not exported from Kit '@kit.AccessibilityKit'`. Build them against the full OpenHarmony SDK, installed with `sdk install --from-archive` (see [Full SDK](#full-sdk)).
 
 The `signingConfigs` block written to `build-profile.json5` mirrors the names used by the project's `products[*].signingConfig` (e.g. `applications/standard/systemui` uses `release`, `launcher` uses `default`). If the project has no products section, `default` is used, and a product that names no `signingConfig` is pointed at it.