@volcengine/tls-observer-cursor-install 0.0.4

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# @volcengine/tls-observer-cursor-install
+
+## 0.0.4
+
+### Patch Changes
+
+- 公网发包
+
+## 0.0.3
+
+### Patch Changes
+
+- Simplify Cursor trace collection
+
+## Unreleased
+
+### Patch Changes
+
+- 将默认运行数据目录调整为 `~/.cursor/plugins/data/tls-observer-cursor`，以兼容统一排障路径。
+
+## 0.0.2
+
+### Patch Changes
+
+- 安装包更新
+
+## 0.0.1
+
+### Patch Changes
+
+- TLS 可观测

package/README.md

@@ -0,0 +1,91 @@
+# TLS Observer Cursor Installer
+
+一键安装 `@volcengine/tls-observer-cursor`，并把 Cursor agent hooks 接入到本机 `~/.cursor/hooks.json`。
+
+## 安装
+
+```bash
+npm exec -y \
+  --package=@volcengine/tls-observer-cursor-install -- \
+  tls-observer-cursor-install
+```
+
+安装器默认从 registry 下载插件 `@latest`。使用 beta：
+
+```bash
+npm exec -y \
+  --package=@volcengine/tls-observer-cursor-install -- \
+  tls-observer-cursor-install --beta
+```
+
+`--plugin-version <version>` 可以指定精确版本或 dist-tag，并覆盖 `--beta`。
+
+## 安装结果
+
+- 插件：`~/.cursor/tls-observer-cursor/plugin`
+- Hooks：`~/.cursor/hooks.json`
+- TLS env：`~/.cursor/tls-observer-cursor.env`
+- 运行数据：`~/.cursor/plugins/data/tls-observer-cursor`
+
+安装器会给每个 Cursor agent hook event 追加一条本插件命令，例如：
+
+```json
+{
+  "version": 1,
+  "hooks": {
+    "stop": [
+      {
+        "command": "\"/path/to/node\" \"~/.cursor/tls-observer-cursor/plugin/run-hook.mjs\"",
+        "timeout": 120
+      }
+    ]
+  }
+}
+```
+
+## 非交互安装
+
+```bash
+npm exec -y \
+  --package=@volcengine/tls-observer-cursor-install -- \
+  tls-observer-cursor-install \
+  --non-interactive \
+  --force \
+  --trace-topic-id <trace-topic-id> \
+  --api-key <api-key>
+```
+
+TLS Region 默认是 `cn-beijing`，TLS Producer endpoint 会自动生成为 `tls-cn-beijing.volces.com`。如需切换 Region，使用 `--region <region>`；如需单独覆盖 endpoint，使用 `--tls-endpoint <host>`。旧的 `--otel-endpoint` 仅保留兼容。
+
+AK/SK 模式将 `--api-key` 替换为 `--ak`、`--sk`，并可提供 `--project-name`、`--app-name` 自动准备 TLS LogApp。
+
+```bash
+npm exec -y \
+  --package=@volcengine/tls-observer-cursor-install -- \
+  tls-observer-cursor-install \
+  --non-interactive \
+  --force \
+  --ak <ak> \
+  --sk <sk> \
+  --project-name cursor_observability \
+  --app-name cursor-observability-demo
+```
+
+AK/SK 自动创建逻辑与 Claude Code installer 保持一致：如未传 `--trace-topic-id`，安装器会创建或复用 Project/LogApp，并从 LogApp 关联资源中发现 `trace` topic 写入 `CURSOR_TLS_TRACE_TOPIC_ID`。API Key 模式不会自动创建 TLS 资源，必须显式传入 trace topic ID。
+
+如果当前账号没有 `Cursor` 模板，可通过 `--template-name` 或 `--template-id` 指定可用模板。
+
+## 本地开发
+
+```bash
+emo run build --filter @volcengine/tls-observer-cursor
+emo run check --filter @volcengine/tls-observer-cursor-install
+emo run build --filter @volcengine/tls-observer-cursor-install
+
+CURSOR_PLUGIN_SOURCE="$PWD/packages/cursor" \
+node packages/cursor-install/bin/tls-observer-cursor-install.mjs --force
+```
+
+安装器会读取源码包的 `publishConfig.directory`，因此本地开发与正式发布都会使用构建生成的 `dist-package`。
+
+`sync-plugin` 仅用于生成安装器内的开发快照；正式安装路径以 registry 下载插件为准。

package/bin/tls-observer-cursor-install.mjs

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+import { run } from '../dist/index.js';
+
+export { run } from '../dist/index.js';
+
+run().catch((error) => {
+  console.error(error instanceof Error ? error.message : String(error));
+  process.exit(1);
+});

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from './installer/installer-runner.js';