oh-aicoding-tool 0.1.2 → 0.1.5

package/README.md

@@ -1,115 +1,114 @@
 # oh-aicoding-tool
 
-One npm package for AI coding tooling:
+`oh-aicoding-tool` 是 AI Coding 工具的一站式聚合安装器。它本身不承载具体
+产品逻辑，而是提供统一的终端菜单和命令转发能力，调用各功能包完成安装和配置。
 
-- Langfuse tracing setup for Claude Code, OpenCode, and Codex.
-- `oh-ai-report` issue feedback plugin installer for OpenCode and Claude Code.
+## 项目定位
 
-## Usage
+本仓是用户侧入口，适合在一次流程中安装或配置多个 AI Coding 辅助能力。
 
-Run locally from this project:
+当前聚合两个功能包：
 
-```sh
-node bin/cli.js
-node bin/cli.js langfuse
-node bin/cli.js report doctor
-```
+| 能力 | npm 包 | 说明 |
+| --- | --- | --- |
+| Langfuse 追踪 | `oh-langfuse` | 配置 Claude Code、OpenCode、Codex 的 Langfuse 链路追踪 |
+| 问题上报插件 | `oh-aireport` | 安装 `/report-ai-issue`，配置 OpenCode / Claude Code 问题上报 |
 
-After publishing to npm:
+CLI 运行时会解析依赖包暴露的 bin 并转发参数。因此功能逻辑变更应优先在对应功能包中完成：
 
-```sh
-npx oh-aicoding-tool
-npx oh-aicoding-tool langfuse setup
-npx oh-aicoding-tool report install opencode --email user@company.com
-```
+- Langfuse 相关能力维护在 `oh-langfuse`；
+- 问题上报相关能力维护在 `oh-aireport`；
+- 聚合菜单、编排逻辑、依赖版本维护在本仓。
+
+## 使用方式
 
-Running `npx oh-aicoding-tool` with no subcommand opens a highlighted TUI.
-Use arrow keys to move, `Space` to select one or more tools, and `Enter` to
-continue. The report path also supports multi-select install targets and guides
-company email configuration before installing.
-
-## Commands
-
-```sh
-oh-aicoding-tool                         # guided menu
-oh-aicoding-tool langfuse setup
-oh-aicoding-tool langfuse setup claude
-oh-aicoding-tool langfuse setup opencode
-oh-aicoding-tool langfuse setup codex
-oh-aicoding-tool langfuse check
-oh-aicoding-tool langfuse check environment
-oh-aicoding-tool langfuse check claude
-oh-aicoding-tool langfuse check opencode
-oh-aicoding-tool langfuse check codex
-oh-aicoding-tool report install opencode
-oh-aicoding-tool report install claude
-oh-aicoding-tool report install both
-oh-aicoding-tool report doctor
+运行交互式安装器：
+
+```bash
+npx oh-aicoding-tool@latest
 ```
 
-Compatibility binaries are still published:
+从当前仓库运行：
 
-```sh
-code-tool-langfuse
-opencode-ohai-report
-ohai-report
+```bash
+npm install
+npm start
 ```
 
-## Langfuse
+交互界面支持：
 
-The interactive UI supports arrow-key navigation in terminals that support raw input. Use `Up` / `Down` to move, number keys for quick selection, `Enter` to select, and `q` or `Esc` to exit. In multi-select setup screens, use `Space` to toggle targets and `Enter` to continue. It uses a soft color palette and falls back to plain numeric prompts when raw terminal input is unavailable.
+- `Up` / `Down`：移动选项；
+- `Space`：选择或取消选择；
+- `Enter`：继续；
+- `q` 或 `Esc`：退出。
 
-`Setup Langfuse` supports selecting one or more setup targets:
+在不支持 raw input 的终端中，会自动退回到数字输入模式。
 
-- Claude Code Langfuse
-- OpenCode Langfuse
-- Codex Langfuse
+## 直接命令
 
-During setup, the only required input is `User ID`, which should be your employee number, for example `h00613222`. Other setup values use the built-in defaults.
+Langfuse 命令会转发给 `oh-langfuse`：
 
-Before setup, the CLI checks required local tools and prints install hints when something is missing:
+```bash
+npx oh-aicoding-tool@latest langfuse setup
+npx oh-aicoding-tool@latest langfuse setup claude
+npx oh-aicoding-tool@latest langfuse setup opencode
+npx oh-aicoding-tool@latest langfuse setup codex
+npx oh-aicoding-tool@latest langfuse check
+npx oh-aicoding-tool@latest langfuse check environment
+```
 
-- Node.js / npm
-- Python / pip for Claude Code setup
-- Python / pip for Codex setup
-- OpenCode CLI for OpenCode setup
+也支持 Langfuse 的短命令别名：
 
-Python package installation uses pip's default package index by default. If you need a custom PyPI mirror, set `CODE_TOOL_PIP_INDEX_URL` or pass `--pipIndexUrl=...`.
+```bash
+npx oh-aicoding-tool@latest setup
+npx oh-aicoding-tool@latest check
+```
 
-Use dry-run mode to preview the script calls without modifying files, installing packages, or writing environment variables:
+问题上报命令会转发给 `oh-aireport`：
 
-```sh
-oh-aicoding-tool langfuse setup --dry-run
+```bash
+npx oh-aicoding-tool@latest report install opencode --email xxxxx@huawei.com
+npx oh-aicoding-tool@latest report install claude
+npx oh-aicoding-tool@latest report install both
 ```
 
-## Issue Report Plugin
+如果交互流程中未填写邮箱，聚合器会向 `oh-aireport` 传递 `--skip-email`，
+邮箱配置可后续单独补充。
 
-The report installer copies the packaged runtime to `~/.config/ohai-report/runtime`, installs OpenCode/Claude command files, and sets `OHAI_REPORT_CLI` to a stable path outside the temporary npx cache.
+## 运行依赖
 
-The guided menu prompts for company email and saves it into the corresponding
-tool config so issue reports can carry a stable user identity.
+聚合器自身需要 Node.js 和 npm。各功能包可能额外需要：
 
-```sh
-oh-aicoding-tool report install opencode --email user@company.com
-oh-aicoding-tool report install claude --email user@company.com
-oh-aicoding-tool report install both --email user@company.com
-oh-aicoding-tool report doctor
-```
+| 流程 | 额外依赖 |
+| --- | --- |
+| Claude Code Langfuse | Python、pip |
+| OpenCode Langfuse | OpenCode CLI |
+| Codex Langfuse | Python、pip |
+| OpenCode 问题上报 | OpenCode 配置目录和插件文件 |
+| Claude Code 问题上报 | Claude Code 配置目录和 Python hook |
 
-## What It Configures
+## 目录结构
 
-For Claude Code Langfuse setup, the CLI installs `langfuse_hook.py`, creates `~/.claude/langfuse-venv`, installs `langfuse` into that virtual environment, updates `~/.claude/settings.json`, and configures the hook environment. On Ubuntu/Debian, install `python3-venv` first if the setup reports that venv support is missing.
+| 路径 | 说明 |
+| --- | --- |
+| `bin/cli.js` | 聚合菜单和命令转发入口 |
+| `package.json` | npm 包元数据和功能包依赖 |
+| `README.md` | 使用和维护说明 |
 
-For OpenCode Langfuse setup, the CLI installs and patches `opencode-plugin-langfuse`, updates `~/.config/opencode/opencode.json`, and can write `LANGFUSE_*` values to the user environment.
+## 发布顺序
 
-For Codex Langfuse setup, the CLI installs `codex_langfuse_notify.py`, creates `~/.codex/langfuse-venv`, installs `langfuse` into that virtual environment, writes Langfuse credentials to `~/.codex/langfuse/config.json`, and updates the top-level `notify` command in `~/.codex/config.toml`. Restart Codex after setup so the notify command is loaded.
+因为本包依赖两个功能包，发布时建议按以下顺序：
 
-The Codex integration is implemented as a notify-hook exporter. On each notify event it incrementally reads the matching `~/.codex/sessions/**/*.jsonl` file, converts new user/assistant/tool/token events into Langfuse observations, and then saves its offset in `~/.codex/langfuse/state.json`. If Codex does not provide a session path in the notify payload, the exporter falls back to the latest session JSONL file.
+1. 发布 `oh-langfuse`。
+2. 发布 `oh-aireport`。
+3. 更新本仓 `package.json` 中两个依赖版本。
+4. 发布 `oh-aicoding-tool`。
 
-## Notes
+发布前建议运行：
+
+```bash
+npm run check
+npm run pack:check
+```
 
-- Langfuse Base URL, Public Key, and Secret Key have built-in defaults for this internal setup. You can override them with `LANGFUSE_BASEURL`, `LANGFUSE_PUBLIC_KEY`, and `LANGFUSE_SECRET_KEY`.
-- The default secret key is not printed in the terminal UI.
-- The CLI calls the Node setup/check scripts directly, so it avoids PowerShell `npm.ps1` execution-policy failures.
-- The Python hook reads `userId` from hook payload first, then from configured environment variables.
-- The Codex hook fails open: tracing errors are logged to `~/.codex/langfuse/codex_langfuse_notify.log` and do not block Codex.
+本仓应保持轻量，只在菜单、编排逻辑、依赖版本或聚合入口行为变化时修改。