{"id":29353638,"url":"https://github.com/frankplus/oniro-ide","last_synced_at":"2025-07-22T07:33:04.954Z","repository":{"id":292361765,"uuid":"980645028","full_name":"frankplus/oniro-ide","owner":"frankplus","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-26T14:50:33.000Z","size":2390,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-20T04:29:13.449Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/frankplus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-09T13:23:55.000Z","updated_at":"2025-05-26T14:50:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"8d25b788-9cef-4fdc-bc06-ebaf11caa3ef","html_url":"https://github.com/frankplus/oniro-ide","commit_stats":null,"previous_names":["frankplus/oniro-ide"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/frankplus/oniro-ide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frankplus%2Foniro-ide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frankplus%2Foniro-ide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frankplus%2Foniro-ide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frankplus%2Foniro-ide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frankplus","download_url":"https://codeload.github.com/frankplus/oniro-ide/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frankplus%2Foniro-ide/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266448016,"owners_count":23930103,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-09T02:08:19.918Z","updated_at":"2025-07-22T07:33:04.934Z","avatar_url":"https://github.com/frankplus.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Oniro IDE\n\nOniro IDE is a lightweight, integrated development environment as a Visual Studio Code Extension tailored for Oniro/OpenHarmony application development. It provides a streamlined workflow for building, signing, deploying, running, and debugging Oniro apps, as well as managing SDKs and emulators.\n\n![screencast](./media/screencast_readme.gif)\n\n## Features\n\n- **Oniro Tree View**: Access all Oniro development actions from a dedicated sidebar, including build, sign, emulator control, app install/launch, SDK Manager, and HiLog Viewer.\n- **Build and Sign**: Compile and sign your Oniro/OpenHarmony application with a single command.\n- **Emulator Management**: Start, stop, and connect to the Oniro emulator directly from VS Code.\n- **App Deployment**: Install and launch `.hap` packages on the emulator or connected device.\n- **Run All**: One-click workflow to start the emulator, build, install, and launch your app, then open the HiLog Viewer for live logs.\n- **HiLog Viewer**: View and filter real-time logs from your running Oniro app within VS Code.\n- **SDK Manager**: Install, update, or remove OpenHarmony SDKs, command-line tools, and the Oniro emulator via a graphical interface.\n- **Oniro Tasks**: Run Oniro-specific build tasks from the VS Code task system.\n- **Debugging**: Debug Oniro applications using the \"Oniro Debug\" configuration.\n\n## Requirements\n\n- Node.js (LTS recommended)\n- Java SDK (for building/signing apps)\n- Required native tools (as per Oniro/OpenHarmony SDK requirements)\n- Oniro/OpenHarmony SDK (managed via the SDK Manager)\n\nEnsure all dependencies are installed and available in your `PATH`.\n\n## Installation\n\n### From Marketplace\n\n1. Open VS Code and go to the Extensions view (`Ctrl+Shift+X`).\n2. Search for **Oniro IDE** and click **Install**.\n\n### From Source (Development)\n\n```bash\n# Clone the repository\ngit clone https://github.com/frankplus/oniro-ide\ncd oniro-ide\n\n# Install dependencies and build\nnpm install\nnpm run compile\n\n# Open in VS Code and launch extension host\ncode .\n# Press F5 to start the Extension Development Host\n```\n\n## Usage\n\n1. Install and enable the Oniro IDE extension in VS Code.\n2. Use the Oniro sidebar to access all main actions, or open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) and search for Oniro commands.\n3. Typical workflow:\n   - **SDK \u0026 Tools Setup**: Open the **SDK Manager** from the sidebar to install or update the required OpenHarmony SDKs, command-line tools, and the Oniro emulator before starting development.\n   - **Signature Configs**: If your application does not already have signing configurations, generate them using the Oniro IDE (see sidebar or command palette for signature config generation commands).\n   - **Build and Sign**: Use **Oniro: Build App** and **Oniro: Sign App** to prepare your application.\n   - **Emulator**: Start the emulator with **Oniro: Start Emulator** and connect if needed (**Oniro: Connect Emulator**).\n   - **Deploy**: Install your `.hap` package using **Oniro: Install App** and launch it with **Oniro: Launch App**.\n   - **Run All**: Use **Oniro: Run All (Emulator, Build, Install, Launch)** for a full automated flow, including log streaming.\n   - **HiLog Viewer**: View logs for your running app with **Oniro: Show HiLog Viewer**.\n\n## Available Commands\n\n- `oniro-ide.runAll`: Run all steps (start emulator, build, install, launch, and open HiLog Viewer)\n- `oniro-ide.build`: Build the Oniro app\n- `oniro-ide.sign`: Sign the Oniro app\n- `oniro-ide.startEmulator`: Start the Oniro emulator\n- `oniro-ide.stopEmulator`: Stop the Oniro emulator\n- `oniro-ide.connectEmulator`: Connect to the running emulator\n- `oniro-ide.installApp`: Install the app on the emulator/device\n- `oniro-ide.launchApp`: Launch the app on the emulator/device\n- `oniro-ide.openSdkManager`: Open the Oniro SDK Manager\n- `oniro-ide.showHilogViewer`: Open the Oniro HiLog log viewer\n\n## Extension Settings\n\nThis extension contributes the following settings (see VS Code settings for details):\n\n- `oniro.sdkRootDir`: Root directory where OpenHarmony SDKs are installed. Default: `${userHome}/setup-ohos-sdk`\n- `oniro.cmdToolsPath`: Directory where OpenHarmony command-line tools are installed. Default: `${userHome}/command-line-tools`\n- `oniro.emulatorDir`: Directory where Oniro emulator is installed. Default: `${userHome}/oniro-emulator`\n\n## Known Issues\n\n- The commands are developed and verified only for the Linux environments\n- Please report issues and feature requests via the GitHub repository.\n\n## Suggested `launch.json` Configuration\n\nTo allow the integrated F5 launch shortcut to automatically execute the Oniro \"Run All\" workflow, add the following configuration to your `.vscode/launch.json` file:\n\n```json\n{\n    \"version\": \"0.2.0\",\n    \"configurations\": [\n        {\n            \"name\": \"Oniro: Launch App (with Run All)\",\n            \"type\": \"oniro-debug\",\n            \"request\": \"launch\"\n        }\n    ]\n}\n```\n\nThis will let you use F5 or the \"Run\" button in VS Code to trigger the Oniro \"Run All\" command for building, deploying, and launching your app.\n\n## ArkTS Language Integration\n\nFor additional integration for the ArkTS language, use the [ArkTS VS Code plugin](https://github.com/Groupguanfang/arkTS), which supports source code navigation and completion. It also supports codelinter to detect errors.\n\n## Release Notes\n\n### 0.0.1\nInitial release: Oniro Tree View, build/sign/deploy workflow, emulator management, SDK Manager, HiLog Viewer, and debugging support.\n\n## Following extension guidelines\n\nEnsure that you've read through the extensions guidelines and follow the best practices for creating your extension.\n\n- [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)\n\n## For more information\n\n- [Visual Studio Code's Extension API](https://code.visualstudio.com/api)\n- [Oniro Project](https://oniroproject.org/)\n- [OpenHarmony Documentation](https://www.openharmony.cn/en/)\n\n\n**Enjoy developing with Oniro IDE!**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrankplus%2Foniro-ide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrankplus%2Foniro-ide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrankplus%2Foniro-ide/lists"}