@windypro-rourou/dsh-logcat 0.2.1 → 0.2.3

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -13,7 +13,13 @@ DSH Web GUI 的安卓实机调试面板（类似 Android Studio 的 Logcat 视
   - 关键词过滤、暂停/继续（暂停时缓冲，恢复自动回放）、清空、复制、导出 .txt
   - 窗口化渲染 + 自动滚动（滚动手动上翻时自动停用）
   - 未授权设备提示「请在手机上点击允许 USB 调试」
-- **Agent 工具**：`logcat_recent`（读取某设备最近 N 条日志，支持级别/关键词过滤）。
+- **Agent 工具**：
+  - `logcat_devices`：列出已连接设备（serial / model / state），判断能否实机调试。
+  - `adb_exec`：在指定设备执行 `adb shell` 命令（安装 APK、启动 Activity、查进程、截图、dump UI 等），
+    破坏性操作（卸载 / 重启 / 清数据）需先确认。
+  - `logcat_recent`：读取某设备最近 N 条日志，支持级别 / 关键词过滤。
+- **实机调试工作流**：构建安卓应用时，agent 的通告会动态列出当前已连接设备（serial + 型号），
+  可先向用户确认后用 `adb_exec` 安装 / 启动、`logcat_recent` 查看崩溃日志，闭环真机调试。
 - **附加能力**：`POST /api/dsh-logcat/exec` 可对设备执行 `adb shell` 命令（UI 后续版本可扩展）。
 
 ## 安装

package/lib/index.js

@@ -36,7 +36,19 @@ const SECTION_ORDER = 152
 
 /** Model-facing announcement: plugin presence, capabilities, and limits. */
 export const LOGCAT_GUIDANCE =
-  '本机已安装 dsh-logcat 插件（DSH Web GUI 的安卓实机调试面板）：侧边栏「Logcat」入口；自动探测本机 adb（ANDROID_HOME / 默认 SDK 路径），对处于调试模式的已连接设备自动附加 logcat 流（threadtime 格式，每设备保留最近 2000 行环形缓冲）；Web 面板支持设备切换、级别/关键词过滤、暂停/清空/导出；agent 可用 logcat_recent 工具读取最近日志。限制：需设备开启 USB 调试并授权本机；logcat 输出可能含敏感信息；执行 adb 命令消耗真实设备资源，先确认再操作。用户提到「Logcat / 安卓日志 / 实机调试 / adb 日志」时即指本插件，请据此协作。'
+  '本机已安装 dsh-logcat 插件（DSH Web GUI 的安卓实机调试面板）：侧边栏「Logcat」入口；自动探测本机 adb，对已连接的调试设备自动附加 logcat 流（threadtime，每设备 2000 行环形缓冲）；Web 面板支持设备切换、级别/关键词过滤、暂停/清空/导出；agent 工具：logcat_devices（列出已连接设备）、adb_exec（在设备上执行 adb shell：安装/启动/查看日志/截图等）、logcat_recent（读取最近日志）。构建安卓应用时若检测到已连接设备，可先向用户确认后用 adb_exec / logcat_recent 直接实机调试。限制：需设备开启 USB 调试并授权本机；logcat 输出可能含敏感信息；adb 命令消耗真实设备资源，破坏性操作（卸载/重启/清数据）先确认再执行。用户提到「Logcat / 安卓日志 / 实机调试 / adb 日志」时即指本插件，请据此协作。'
+
+/** Dynamic model-facing announcement: base guidance plus currently attached devices. */
+function logcatGuidance(engine) {
+  return () => {
+    const devices = engine.deviceList()
+    const live = devices.filter((d) => d.state === 'device')
+    const deviceLine = live.length > 0
+      ? `当前已连接安卓设备：${live.map((d) => `${d.serial}${d.model !== '' ? `（${d.model}）` : ''}`).join('、')}（已授权，可实机调试：安装 APK / 启动应用 / logcat / 截图等）。`
+      : '当前无已连接的安卓设备（插上设备并开启 USB 调试后会自动识别）。'
+    return `${LOGCAT_GUIDANCE}\n${deviceLine}`
+  }
+}
 
 /** ---------------------------------------------------------------- adb */
 
@@ -514,6 +526,96 @@ function logcatRecentTool(engine) {
   })
 }
 
+/** The logcat_devices agent tool: list attached adb devices for on-device debugging. */
+function logcatDevicesTool(engine) {
+  return defineTool({
+    name: 'logcat_devices',
+    description: 'List currently attached Android devices (serial, model, state) for on-device debugging. ' +
+      'Triggers: check adb devices, see which phones are connected, decide whether to debug a build on a real device.',
+    parameters: {},
+    output: {
+      schema: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          devices: {
+            type: 'array',
+            required: true,
+            items: {
+              type: 'object',
+              additionalProperties: false,
+              properties: {
+                serial: { type: 'string', required: true },
+                model: { type: 'string', required: true },
+                state: { type: 'string', required: true },
+              },
+            },
+          },
+        },
+      },
+      render: (_args, value) => {
+        const devices = value?.devices ?? []
+        if (devices.length === 0) return [{ type: 'text', text: '(no devices attached)' }]
+        const lines = devices.map((d) => `${d.state.padEnd(11)} ${(d.model || '?').padEnd(22)} ${d.serial}`)
+        return [{ type: 'text', text: lines.join('\n') }]
+      },
+    },
+    async execute() {
+      return { devices: engine.deviceList().map(({ serial, model, state }) => ({ serial, model, state })) }
+    },
+  })
+}
+
+/** The adb_exec agent tool: run one adb shell command on a device. */
+function adbExecTool(engine) {
+  return defineTool({
+    name: 'adb_exec',
+    description: 'Run one adb shell command on an attached Android device — e.g. install an APK (pm install -r <path>), ' +
+      'start an activity (am start -n pkg/.Activity), list processes, take a screenshot (screencap -p /sdcard/x.png), ' +
+      'or dump UI (uiautomator dump). NOTE: executes real commands on the user\'s device and consumes device resources — ' +
+      'confirm intent before destructive actions (uninstall, reboot, clear data, factory reset).',
+    parameters: {
+      serial: { type: 'string', description: 'Device serial from logcat_devices (optional; defaults to the first attached device).' },
+      command: { type: 'string', description: 'The shell command to run without the "adb shell" prefix, e.g. "pm list packages | grep com.example" or "am start -n com.example/.MainActivity".' },
+      timeoutMs: { type: 'integer', description: 'Command timeout in ms (default 15000, max 120000).' },
+    },
+    output: {
+      schema: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          ok: { type: 'boolean', required: true },
+          code: { type: 'integer' },
+          stdout: { type: 'string', required: true },
+          stderr: { type: 'string', required: true },
+        },
+      },
+      render: (_args, value) => {
+        const out = value?.stdout ?? ''
+        const err = value?.stderr ?? ''
+        const parts = []
+        if (out !== '') parts.push(out.trimEnd())
+        if (err !== '') parts.push('stderr: ' + err.trimEnd())
+        if (parts.length === 0) parts.push(`(exit ${value?.code ?? '?'}, no output)`)
+        return [{ type: 'text', text: parts.join('\n') }]
+      },
+    },
+    async execute(args) {
+      const devices = engine.deviceList()
+      const serial = typeof args.serial === 'string' && args.serial !== ''
+        ? args.serial
+        : devices.find((d) => d.state === 'device')?.serial ?? ''
+      const command = typeof args.command === 'string' ? args.command.trim() : ''
+      if (engine.adb === null) return { ok: false, code: null, stdout: '', stderr: 'adb not found on this host' }
+      if (serial === '') return { ok: false, code: null, stdout: '', stderr: 'no attached device; connect and authorize one first' }
+      if (command === '') return { ok: false, code: null, stdout: '', stderr: 'command is required' }
+      const timeoutMs = Math.min(Math.max(Number(args.timeoutMs ?? 15000) || 15000, 1000), 120000)
+      const result = await runAdbFull(engine.adb, ['-s', serial, 'shell', command], timeoutMs)
+      return { ok: result.ok, code: result.code, stdout: result.stdout, stderr: result.stderr }
+    },
+  })
+}
+
 /** ------------------------------------------------------------------ */
 
 /** Mount the adb engine, routes, tool, and announcement. */
@@ -565,7 +667,7 @@ export function apply(ctx, config) {
       disposeSection = ctx.systemPrompt.section({
         name: 'plugin:dsh-logcat',
         order: SECTION_ORDER,
-        text: LOGCAT_GUIDANCE,
+        text: logcatGuidance(engine),
       })
     }
     disposeRoutes = ctx.effect(() => {
@@ -577,7 +679,11 @@ export function apply(ctx, config) {
       }
     }, 'dsh-logcat: routes')
     disposeTools = ctx.effect(() => {
-      const disposers = [logcatRecentTool(engine)].map((tool) => ctx.tools.register(tool))
+      const disposers = [
+        logcatRecentTool(engine),
+        logcatDevicesTool(engine),
+        adbExecTool(engine),
+      ].map((tool) => ctx.tools.register(tool))
       return () => { for (const dispose of disposers) dispose() }
     }, 'dsh-logcat: tools')
     initOnce()

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@windypro-rourou/dsh-logcat",
   "description": "Android Logcat viewer for the dsh web GUI: auto-connects to any adb device in debug mode, live logcat stream with level/keyword filters, pause/clear/export, plus agent tools (logcat_recent). Hot-pluggable — mounted via ~/.dsh/cordis.patch.yml + a profile node_modules copy, no dsh source changes.",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "type": "module",
   "packageManager": "pnpm@11.22.0",
   "engines": {