Skip to content

Commit 542d5cf

Browse files
committed
moar docs updates
1 parent 4e95021 commit 542d5cf

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

packages/cli/src/lib/plugins/remoteCache.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -426,13 +426,15 @@ export const remoteCachePlugin =
426426
},
427427
{
428428
name: '-p, --platform <string>',
429-
description: 'Select platform, e.g. ios or android',
429+
description:
430+
'Select platform, e.g. ios, android, or harmony (experimental)',
430431
},
431432
{
432433
name: '-t, --traits <list>',
433434
description: `Comma-separated traits that construct final artifact name. Traits for Android are: variant; for iOS: destination and configuration.
434435
Example iOS: --traits simulator,Release
435-
Example Android: --traits debug`,
436+
Example Android: --traits debug
437+
Example Harmony: --traits debug`,
436438
parse: (val: string) => val.split(','),
437439
},
438440
{

website/src/docs/cli/introduction.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,17 @@ The `sign:android <binaryPath>` command signs your Android app with a keystore,
261261

262262
## Platform HarmonyOS (experimental)
263263

264+
:::warning
265+
HarmonyOS integration is currently experimental and not fully feature complete with iOS and Android platforms. The API and functionality may change in future releases.
266+
267+
Missing functionality:
268+
269+
- Ready to use GitHub Action
270+
- Re-signing with `sign:harmony` command
271+
- Running on emulator (DevEco Studio doesn't allow for emulators outside of China)
272+
273+
:::
274+
264275
### `rock build:harmony` Options
265276

266277
The `build:harmony` command builds your HarmonyOS app for emulators or devices, producing HAP files. It follows this build strategy:
@@ -403,7 +414,7 @@ Actions have different options available:
403414
| `--name <string>` | Full artifact name to operate on. Cannot be used with `--platform` or `--traits` |
404415
| `--all` | List or delete all matching artifacts (affects `list` and `delete` actions only) |
405416
| `--all-but-latest` | Delete all but the latest matching artifact (affects `delete` action only) |
406-
| `-p, --platform <string>` | Platform to target (`ios` or `android`). Must be used with `--traits` |
417+
| `-p, --platform <string>` | Platform to target (`ios`, `android`, or `harmony`). Must be used with `--traits` |
407418
| `-t, --traits <list>` | Comma-separated traits that construct the final artifact name. For Android: variant (e.g., `debug`, `release`). For iOS: destination and configuration (e.g., `simulator,Release`) |
408419
| `--binary-path <string>` | Path to the binary to upload (used with `upload` action) |
409420
| `--ad-hoc <string>` | Upload IPA for ad-hoc distribution and installation from URL. Additionally uploads index.html and manifest.plist' |

0 commit comments

Comments
 (0)