@openbkn/bkn-sdk 0.1.1-alpha.9 → 0.1.2

package/LICENSE

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/

package/NOTICE

@@ -0,0 +1,21 @@
+BKN SDK
+Copyright 2026 OpenBKN
+
+BKN SDK is part of the OpenBKN project.
+
+================================================================
+1. BKN SDK (Apache License 2.0)
+================================================================
+BKN SDK is independently developed by OpenBKN, is copyright OpenBKN,
+and is licensed under the Apache License, Version 2.0.
+
+  Full license text:              LICENSE
+  Apache License, Version 2.0:    http://www.apache.org/licenses/LICENSE-2.0
+
+================================================================
+2. Third-party dependencies
+================================================================
+This product depends on and may bundle third-party software, each of
+which remains under its own license as declared in its package
+metadata (see package.json and the dependency manifests). Those
+licenses are not altered by this project's license.

package/README.md

@@ -2,15 +2,14 @@
 
 Unified TypeScript SDK + CLI for the **BKN** (Business Knowledge Network) platform.
 One toolkit, two surfaces: the importable SDK and the `openbkn` CLI — both backed
-by the same domain logic. A slim rewrite of the legacy `kweaver-sdk` +
-`kweaver-admin`, merged into one package (the operator CLI lives under
-`openbkn admin`). Backend-only; no web UI.
-
-> Status: every legacy command/subcommand is implemented and full-depth
-> `--help`-equivalent with `kweaver` / `kweaver-admin` (196/196 parity test).
-> Reads + writes across all domains are validated against a live platform; a few
-> paths are environment-gated on the test cluster (EACP `change-password`/`audit`
-> upstream, physical-catalog `create-from-*`, populated trace index) — see
+by the same domain logic. A single unified CLI for the BKN platform, with the
+operator surface nested under `openbkn admin`. Backend-only; no web UI.
+
+> Status: every command/subcommand is implemented and self-consistent, with a
+> full-depth grouped `--help` for every node. Reads + writes across all domains
+> are validated against a live platform; a few paths are environment-gated on the
+> test cluster (EACP `change-password`/`audit` upstream, physical-catalog
+> `create-from-*`, populated trace index) — see
 > `docs/exec-plans/tech-debt-tracker.md`.
 
 ## Install
@@ -46,14 +45,15 @@ openbkn model llm list
 openbkn agent list
 openbkn agent sessions <agent-key>
 
-# Operator (kweaver-admin, nested)
+# Operator (nested)
 openbkn admin org list
 openbkn admin role list
 
 # Raw passthrough to any endpoint
 openbkn call /api/ontology-manager/v1/knowledge-networks
 
-# Global flags: --base-url, --token, --user, --json/--compact, -bd/--biz-domain, -k/--insecure
+# Global flags: --base-url, --token, --user, --json/--compact, -bd/--biz-domain, -k/--insecure,
+#               --conversation-id/--interaction-id (BKN Trace correlation; also BKN_CONVERSATION_ID/BKN_INTERACTION_ID)
 openbkn --help        # grouped command map
 ```
 
@@ -78,17 +78,15 @@ Importing the package has no side effects; `createClient` resolves config explic
 ```bash
 npm install
 npm run lint     # biome + tsc --noEmit
-npm test         # vitest (unit; equivalence suite gated by BKN_EQUIV_LIVE)
+npm test         # vitest (unit)
 npm run build    # tsup → dist/ (library + `openbkn` bin)
 ```
 
-## Equivalence with the legacy CLIs
+## Help system
 
-`openbkn` mirrors the installed `kweaver` / `kweaver-admin` command trees
-(`kweaver <x>` → `openbkn <x>`, `kweaver-admin <x>` → `openbkn admin <x>`).
-Golden `--help` baselines and a full-depth parity test live in
-`test/equivalence/` — **196/196** commands match (every node exists and its
-`--help` covers the legacy flags + arguments). Run live with `BKN_EQUIV_LIVE=1`.
+Every command, subcommand, and sub-subcommand ships a grouped `--help` that
+lists its flags and arguments, so the tree is discoverable end to end.
+`openbkn help all` dumps the full per-action signature list.
 
 ## Agent skill
 
@@ -99,21 +97,30 @@ command-group map, examples, and cautions) plus per-domain cheat sheets under
 `references/` (auth, bkn, agent, model, vega, resource, dataflow, context,
 skill, toolbox, trace, admin, call) and two how-tos (build-a-KN, troubleshooting).
 
-The skill is **not** part of the npm package — it's registered separately:
+A second skill, `skills/create-bkn/`, guides an AI through **authoring** a BKN
+definition tree (`network.bkn` + typed `object_types/` / `relation_types/` /
+`action_types/` / `concept_groups/` files, per the v2.0.1 spec) — with the
+format spec, templates, and a worked example under `references/`. It pairs with
+the `openbkn` skill, which then runs `openbkn bkn validate` / `push` on the
+tree it produced.
+
+Neither skill is part of the npm package — they're registered separately:
 
 ```bash
-# Install the skill (globally), then ask in natural language:
-npx skills add openbkn-ai/bkn-sdk@openbkn -g -y
+# Install a skill (globally), then ask in natural language:
+npx skills add openbkn-ai/bkn-sdk@openbkn -g -y      # operate the platform
+npx skills add openbkn-ai/bkn-sdk@create-bkn -g -y   # author .bkn files
 
 #   "列出所有知识网络"  /  "list all knowledge networks"
 #   "从 Vega catalog vcat-1 建一个名为 customers 的知识网络并构建索引"
-#   "诊断会话 conv-123 的 trace，带 LLM 判定"
+#   "帮我建一个描述订单域的 BKN 知识网络文件"  /  "author a BKN network for the orders domain"
 ```
 
-The skill assumes the `openbkn` CLI is installed (`npm i -g @openbkn/bkn-sdk`)
-and you are logged in (`openbkn auth login`). It always defers to live
-`openbkn <group> <sub> --help` for exact flags.
+The `openbkn` skill assumes the `openbkn` CLI is installed (`npm i -g
+@openbkn/bkn-sdk`) and you are logged in (`openbkn auth login`). It always defers
+to live `openbkn <group> <sub> --help` for exact flags.
 
 ## License
 
-Apache-2.0
+BKN SDK is part of the OpenBKN project and is licensed under the
+**Apache License, Version 2.0**. See [LICENSE](LICENSE) and [NOTICE](NOTICE).

package/README.zh.md

@@ -1,11 +1,10 @@
 # @openbkn/bkn-sdk
 
 BKN（Business Knowledge Network）平台的统一 TypeScript SDK + CLI。一套工具、两个入口：
-可 import 的 SDK 与 `openbkn` 命令行——共享同一套领域逻辑。这是对旧版
-`kweaver-sdk` + `kweaver-admin` 的精简重写，合并为一个包（运维 CLI 收进
-`openbkn admin` 子命令）。纯后端，无 Web UI。
+可 import 的 SDK 与 `openbkn` 命令行——共享同一套领域逻辑。面向 BKN 平台的
+统一命令行工具，运维面收进 `openbkn admin` 子命令。纯后端，无 Web UI。
 
-> 状态：预发布。各域的读命令已实现并在真实平台上验证；部分写操作与 Trace-AI
+> 状态：预发布。各域的读命令已实现并在真实平台上验证；部分写操作与 BKN Trace
 > 引擎仍在进行中（见 `docs/exec-plans/tech-debt-tracker.md`）。
 
 ## 安装
@@ -40,7 +39,7 @@ openbkn model llm list
 openbkn agent list
 openbkn agent sessions <agent-key>
 
-# 运维（kweaver-admin，嵌套）
+# 运维（嵌套）
 openbkn admin org list
 openbkn admin role list
 
@@ -48,6 +47,7 @@ openbkn admin role list
 openbkn call /api/ontology-manager/v1/knowledge-networks
 
 # 全局参数：--base-url --token --user --json/--compact -bd/--biz-domain -k/--insecure
+#           --conversation-id/--interaction-id（BKN Trace 关联，等价 env：BKN_CONVERSATION_ID/BKN_INTERACTION_ID）
 openbkn --help        # 分组命令树
 ```
 
@@ -72,17 +72,16 @@ import 本包无副作用；`createClient` 显式解析配置。
 ```bash
 npm install
 npm run lint     # biome + tsc --noEmit
-npm test         # vitest（单测；等价套件由 BKN_EQUIV_LIVE 控制）
+npm test         # vitest（单测）
 npm run build    # tsup → dist/（库 + openbkn bin）
 ```
 
-## 与旧 CLI 的一致性
+## 帮助系统
 
-`openbkn` 对齐已安装的 `kweaver` / `kweaver-admin` 命令树
-（`kweaver <x>` → `openbkn <x>`，`kweaver-admin <x>` → `openbkn admin <x>`）。
-全深度 `--help` 黄金基线与一致性测试见 `test/equivalence/`
-（用 `BKN_EQUIV_LIVE=1` 真机跑）。
+每个命令、子命令、孙命令都带分组 `--help`，列出各自的参数与位置参数，
+整棵命令树可端到端发现。`openbkn help all` 输出全深度的逐动作签名清单。
 
 ## 许可证
 
-Apache-2.0
+BKN SDK 是 OpenBKN 项目的一部分，采用 **Apache License, Version 2.0**。
+见 [LICENSE](LICENSE) 与 [NOTICE](NOTICE)。