@volcengine/tls-observer-pi-install 0.0.1

package/LICENCE

@@ -0,0 +1,13 @@
+# Copyright 2023 Beijing Volcano Engine Technology Ltd.
+#
+# 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

@@ -0,0 +1,70 @@
+# TLS Observer Pi Installer
+
+一键安装 `@volcengine/tls-observer-pi` 到 Pi Coding Agent。
+
+## 安装
+
+```bash
+npm exec -y \
+  --package=@volcengine/tls-observer-pi-install -- \
+  tls-observer-pi-install
+```
+
+安装器默认从 registry 安装插件 `@latest`。使用 beta：
+
+```bash
+npm exec -y \
+  --package=@volcengine/tls-observer-pi-install -- \
+  tls-observer-pi-install --beta
+```
+
+`--plugin-version <version>` 可以指定精确版本或 dist-tag，并覆盖 `--beta`。
+
+## 安装结果
+
+- Pi 插件包：由 Pi CLI 通过 `pi install` 安装，可使用 `pi list` 查看
+- TLS env：`~/.pi/agent/tls-observer-pi.env`
+- 运行数据：`~/.pi/agent/tls-observer-pi`
+
+安装器不会写入当前项目的 `.pi/settings.json`。本地路径安装使用用户级 `pi install <path>`；不要使用 `pi install <path> -l` 代替安装器默认行为，因为 `-l` 会写入项目级配置。
+
+如果 `pi` 不在 `PATH`，可以通过 `--pi-bin <path>` 或 `PI_TLS_PI_BIN=/absolute/path/to/pi` 指定 Pi CLI 路径。
+
+## 非交互安装
+
+```bash
+npm exec -y \
+  --package=@volcengine/tls-observer-pi-install -- \
+  tls-observer-pi-install \
+  --non-interactive \
+  --force \
+  --trace-topic-id <trace-topic-id> \
+  --api-key <api-key>
+```
+
+TLS Region 默认是 `cn-beijing`，TLS Producer endpoint 会根据最终 Region 自动生成为 `tls-cn-beijing.volces.com`。如需切换 Region，使用 `--region <region>`；如需单独覆盖 endpoint，使用 `--tls-endpoint <host>`。
+
+AK/SK 模式将 `--api-key` 替换为 `--ak`、`--sk`。Pi 安装器不会自动创建或发现 TLS LogApp，因此仍需提供 `--trace-topic-id`。
+
+如果只想安装插件、不写 TLS env，可使用：
+
+```bash
+npm exec -y \
+  --package=@volcengine/tls-observer-pi-install -- \
+  tls-observer-pi-install --skip-tls-config
+```
+
+## 本地开发
+
+```bash
+emo run build --filter @volcengine/tls-observer-pi
+emo run check --filter @volcengine/tls-observer-pi-install
+emo run build --filter @volcengine/tls-observer-pi-install
+
+PI_PLUGIN_SOURCE="$PWD/packages/pi" \
+node packages/pi-install/bin/tls-observer-pi-install.mjs --force --skip-tls-config
+```
+
+安装器会读取源码包的 `publishConfig.directory`，因此本地开发与正式发布都会使用构建生成的 `dist-package`。`PI_PLUGIN_SOURCE` 也可以直接指向 `packages/pi/dist-package`。
+
+本地源安装使用 `pi install <local-path>`。历史兼容变量 `PI_TLS_PLUGIN_SOURCE`、`TRAE_TLS_PLUGIN_SOURCE` 仍可识别，但新命令建议使用 `PI_PLUGIN_SOURCE`。

package/bin/tls-observer-pi-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 { applyDerivedDefaults, buildTlsEnv, findLocalPluginSource, installPiPackage, installPlugin, parseCliOptions, pluginPackageSpec, run, runInstaller, validateBaseTlsConfig, validateTlsConfig, writeEnvFile, writeTlsEnv, } from './installer/installer-runner';