bkn-kweaver

Name: bkn-kweaver
Author: kweaver-ai

309stars53forks

How to install bkn-kweaver?

kweaver-ai/kweaver-dip/bkn-kweaver

$npx -y skills add kweaver-ai/kweaver-dip --skill bkn-kweaver

Installs into the current project.

Summary

KWeaver CLI 操作层 — 内化自 kweaver-core。覆盖认证、平台业务域（config）、知识网络管理与查询、Agent CRUD 与对话、数据源管理、数据视图、Skill 注册、Vega 可观测、context-loader 语义搜索、通用 API 调用。仅由 bkn-creator pipeline 内部读取，不独立注册到宿主 skill 系统。

Files · 1

View on GitHub

SKILL.md

1	# KWeaver CLI
2
3	KWeaver 平台的命令行工具，覆盖认证、平台业务域（`config`）、知识网络管理与查询、Agent CRUD 与对话、数据源管理。
4
5	## 安装
6
7	```bash
8	npm install -g @kweaver-ai/kweaver-sdk
9	```
10
11	需 Node.js 22+。也可用 `npx kweaver` 临时运行。
12
13	## 使用方式
14
15	```bash
16	kweaver [--user <userId\|username>] <command> [subcommand] [options]
17	```
18
19	完整子命令与参数以当前安装的 CLI 为准：运行 `kweaver --help`（或 `-h`）查看与代码同步的用法列表；查版本用 `kweaver --version` / `-V` / `kweaver version`。子命令细节用 `kweaver <group> <subcommand> --help`（例如 `kweaver auth --help`、`kweaver bkn push --help`）。
20
21	本 skill 下的 `references/.md` 与 CLI 行为对齐；表格与 reference 为速查*，新增标志（如 `auth` 的 `--alias`、BKN `validate`/`push` 的编码选项）在 reference 中有说明。
22
23	别名：`kweaver curl` 等同于 `kweaver call`；`kweaver context` 等同于 `kweaver context-loader`。
24
25	业务域（business domain）：多数请求依赖 `x-business-domain`。`kweaver auth login` 后应优先执行 `kweaver config show`；列表为空时用 `config list-bd` 查看平台可选域，再 `config set-bd <uuid>`。详见 [`references/config.md`](references/config.md)。
26
27	## 使用前提
28
29	认证凭据通过 `~/.kweaver/` 管理。默认操作：在存在 `refresh_token` 时，用 OAuth2 `refresh_token` 授权换发新的 `access_token`（过期或临近过期时自动执行，无需额外参数）。禁止提前检查环境变量，禁止询问用户提供密码或 Token。
30
31	### 认证优先级
32
33	1. `KWEAVER_TOKEN` + `KWEAVER_BASE_URL` 环境变量 → 静态 Token（如存在则优先使用，不会用 refresh 换发）
34	2. `~/.kweaver/` 凭据（`kweaver auth login` 写入）→ 默认用 refresh_token 换发 access_token（推荐）
35	3. `KWEAVER_USER` 环境变量（或全局 `--user` 参数）→ 使用指定用户的凭证，不切换活跃用户
36
37	### 业务域优先级（与认证独立）
38
39	1. `KWEAVER_BUSINESS_DOMAIN` 环境变量
40	2. 当前平台 `config.json` 中的 `businessDomain`（`kweaver config set-bd`）
41	3. 默认 `bd_public`（首次登录后 CLI 可能已自动写入更合适的值）
42
43	## 命令组总览
44
45	\| 命令组 \| 说明 \| 常用命令 \| 详细参考 \|
46	\|--------\|------\|---------\|---------\|
47	\| `auth` \| 认证管理（支持多账号） \| `auth login <url> [--alias name]`（简写：`auth <url> [--alias …]`）；可选 `--no-browser`、`-u/-p` HTTP `/oauth2/signin`；初始密码（401001017）下 TTY 可交互改密，脚本用 `--new-password`；`auth change-password [<url>] [-u …]`（EACP 改密；URL 与 `-u` 都可省略，分别回退到当前平台与当前激活账号；无需 token）；`auth list` / `auth users` / `auth switch`；全局 `--user` / `KWEAVER_USER`；无当前平台时 `auth status` / `whoami` 可用 env 兜底（见 `references/auth.md`） \| `references/auth.md` \|
48	\| `token` \| 打印当前 access token（自动刷新） \| `token` \| — \|
49	\| `config` \| 平台业务域（优先于多数 bkn/agent/ds 操作） \| `config show`, `config list-bd`, `config set-bd <uuid>` \| `references/config.md` \|
50	\| `bkn` \| BKN 知识网络管理、Schema、查询、Action \| `bkn validate`/`push` 默认检测 `.bkn` 编码并规范为 UTF-8，可用 `--no-detect-encoding` 或 `--source-encoding gb18030`；另有 `pull`、`object-type`、`search`、`create-from-ds`/`create-from-csv` 等，见 `references/bkn.md` \| `references/bkn.md` \|
51	\| `agent` \| Agent CRUD、发布、对话、Trace、模板、分类 \| `agent list`, `agent get <id>`, `agent create --name <n> --profile <p> --config <json>`, `agent publish <id> --category-id <cid>`, `agent chat <id> -m "..."`、`agent category-list`, `agent template-list`, `agent template-get <tpl_id>`、`agent sessions <agent_id>`、`agent history <conversation_id>`、`agent trace <conversation_id>` \| `references/agent.md` \|
52	\| `ds` \| 数据源管理 \| `ds list`, `ds get <id>`, `ds import-csv <ds_id> --files <glob> [--recreate]` \| `references/ds.md` \|
53	\| `dataview` \| 数据视图（mdl-data-model / vega-backend） \| `dataview list`、`find --name`、`get`、`query`、`delete`；BKN 绑定也可用 `vega resource` ID（type=resource） \| `references/dataview.md` \|
54	\| `dataflow` \| Dataflow 文档流程 \| `dataflow list`, `dataflow run <dagId> --file <path>`, `dataflow run <dagId> --url <remote-url> --name <filename>`, `dataflow runs <dagId> [--since <date-like>]`, `dataflow logs <dagId> <instanceId> [--detail]` \| `references/dataflow.md` \|
55	\| `skill` \| Skill 注册、市场查找、渐进式读取、下载与安装 \| `skill list`、`market`、`register --zip-file`、`content`、`read-file`、`install` \| `references/skill.md` \|
56	\| `toolbox` \| 平台工具箱（toolbox）管理 \| `toolbox create --name <n> --service-url <url>`、`toolbox list`、`toolbox publish/unpublish <id>`、`toolbox delete <id> [-y]` \| `references/toolbox.md` \|
57	\| `tool` \| 工具箱内 tool 注册与启停（OpenAPI） \| `tool upload --toolbox <id> <openapi-spec>`、`tool list --toolbox <id>`、`tool enable/disable --toolbox <id> <tool-id>...` \| `references/tool.md` \|
58	\| `vega` \| Vega 可观测平台 \| `vega health`, `vega catalog list`, `vega resource list`, `vega query execute -d <json>`, `vega sql --resource-type <t> --query "<sql>"` / `vega sql -d <json>` \| `references/vega.md` \|
59	\| `context-loader` \| MCP 分层检索 \| `context-loader config show`, `context-loader kn-search <query>` \| `references/context-loader.md` \|
60	\| `call` \| 通用 API 调用 \| `call <url> [-X POST] [-d '...']`（可用 `curl` 别名；支持 `--url`、`--data-raw` 等，见 `kweaver --help`） \| `references/call.md` \|
61
62	## 操作指南
63
64	\| 场景 \| 说明 \| 详细参考 \|
65	\|------\|------\|---------\|
66	\| 登录后确认业务域 \| `config show`；若异常或列表为空 → `config list-bd` → `config set-bd <uuid>` \| [references/config.md](references/config.md) \|
67	\| 从数据库/CSV 构建 KN \| 连接数据源 → CSV 导入 → 创建 KN → 构建索引 → 查询验证 → 绑定 Agent \| [references/build-kn-from-db.md](references/build-kn-from-db.md) \|
68	\| CLI 排障速查 \| 权限、pull、

People who liked this also viewed

6 picks

Type

bkn-kweaver

309stars53forks

View on GitHub

How to install bkn-kweaver?

kweaver-ai/kweaver-dip/bkn-kweaver

$npx -y skills add kweaver-ai/kweaver-dip --skill bkn-kweaver

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# KWeaver CLI
2
3	KWeaver 平台的命令行工具，覆盖认证、平台业务域（`config`）、知识网络管理与查询、Agent CRUD 与对话、数据源管理。
4
5	## 安装
6
7	```bash
8	npm install -g @kweaver-ai/kweaver-sdk
9	```
10
11	需 Node.js 22+。也可用 `npx kweaver` 临时运行。
12
13	## 使用方式
14
15	```bash
16	kweaver [--user <userId\|username>] <command> [subcommand] [options]
17	```
18
19	完整子命令与参数以当前安装的 CLI 为准：运行 `kweaver --help`（或 `-h`）查看与代码同步的用法列表；查版本用 `kweaver --version` / `-V` / `kweaver version`。子命令细节用 `kweaver <group> <subcommand> --help`（例如 `kweaver auth --help`、`kweaver bkn push --help`）。
20
21	本 skill 下的 `references/.md` 与 CLI 行为对齐；表格与 reference 为速查*，新增标志（如 `auth` 的 `--alias`、BKN `validate`/`push` 的编码选项）在 reference 中有说明。
22
23	别名：`kweaver curl` 等同于 `kweaver call`；`kweaver context` 等同于 `kweaver context-loader`。
24
25	业务域（business domain）：多数请求依赖 `x-business-domain`。`kweaver auth login` 后应优先执行 `kweaver config show`；列表为空时用 `config list-bd` 查看平台可选域，再 `config set-bd <uuid>`。详见 [`references/config.md`](references/config.md)。
26
27	## 使用前提
28
29	认证凭据通过 `~/.kweaver/` 管理。默认操作：在存在 `refresh_token` 时，用 OAuth2 `refresh_token` 授权换发新的 `access_token`（过期或临近过期时自动执行，无需额外参数）。禁止提前检查环境变量，禁止询问用户提供密码或 Token。
30
31	### 认证优先级
32
33	1. `KWEAVER_TOKEN` + `KWEAVER_BASE_URL` 环境变量 → 静态 Token（如存在则优先使用，不会用 refresh 换发）
34	2. `~/.kweaver/` 凭据（`kweaver auth login` 写入）→ 默认用 refresh_token 换发 access_token（推荐）
35	3. `KWEAVER_USER` 环境变量（或全局 `--user` 参数）→ 使用指定用户的凭证，不切换活跃用户
36
37	### 业务域优先级（与认证独立）
38
39	1. `KWEAVER_BUSINESS_DOMAIN` 环境变量
40	2. 当前平台 `config.json` 中的 `businessDomain`（`kweaver config set-bd`）
41	3. 默认 `bd_public`（首次登录后 CLI 可能已自动写入更合适的值）
42
43	## 命令组总览
44
45	\| 命令组 \| 说明 \| 常用命令 \| 详细参考 \|
46	\|--------\|------\|---------\|---------\|
47	\| `auth` \| 认证管理（支持多账号） \| `auth login <url> [--alias name]`（简写：`auth <url> [--alias …]`）；可选 `--no-browser`、`-u/-p` HTTP `/oauth2/signin`；初始密码（401001017）下 TTY 可交互改密，脚本用 `--new-password`；`auth change-password [<url>] [-u …]`（EACP 改密；URL 与 `-u` 都可省略，分别回退到当前平台与当前激活账号；无需 token）；`auth list` / `auth users` / `auth switch`；全局 `--user` / `KWEAVER_USER`；无当前平台时 `auth status` / `whoami` 可用 env 兜底（见 `references/auth.md`） \| `references/auth.md` \|
48	\| `token` \| 打印当前 access token（自动刷新） \| `token` \| — \|
49	\| `config` \| 平台业务域（优先于多数 bkn/agent/ds 操作） \| `config show`, `config list-bd`, `config set-bd <uuid>` \| `references/config.md` \|
50	\| `bkn` \| BKN 知识网络管理、Schema、查询、Action \| `bkn validate`/`push` 默认检测 `.bkn` 编码并规范为 UTF-8，可用 `--no-detect-encoding` 或 `--source-encoding gb18030`；另有 `pull`、`object-type`、`search`、`create-from-ds`/`create-from-csv` 等，见 `references/bkn.md` \| `references/bkn.md` \|
51	\| `agent` \| Agent CRUD、发布、对话、Trace、模板、分类 \| `agent list`, `agent get <id>`, `agent create --name <n> --profile <p> --config <json>`, `agent publish <id> --category-id <cid>`, `agent chat <id> -m "..."`、`agent category-list`, `agent template-list`, `agent template-get <tpl_id>`、`agent sessions <agent_id>`、`agent history <conversation_id>`、`agent trace <conversation_id>` \| `references/agent.md` \|
52	\| `ds` \| 数据源管理 \| `ds list`, `ds get <id>`, `ds import-csv <ds_id> --files <glob> [--recreate]` \| `references/ds.md` \|
53	\| `dataview` \| 数据视图（mdl-data-model / vega-backend） \| `dataview list`、`find --name`、`get`、`query`、`delete`；BKN 绑定也可用 `vega resource` ID（type=resource） \| `references/dataview.md` \|
54	\| `dataflow` \| Dataflow 文档流程 \| `dataflow list`, `dataflow run <dagId> --file <path>`, `dataflow run <dagId> --url <remote-url> --name <filename>`, `dataflow runs <dagId> [--since <date-like>]`, `dataflow logs <dagId> <instanceId> [--detail]` \| `references/dataflow.md` \|
55	\| `skill` \| Skill 注册、市场查找、渐进式读取、下载与安装 \| `skill list`、`market`、`register --zip-file`、`content`、`read-file`、`install` \| `references/skill.md` \|
56	\| `toolbox` \| 平台工具箱（toolbox）管理 \| `toolbox create --name <n> --service-url <url>`、`toolbox list`、`toolbox publish/unpublish <id>`、`toolbox delete <id> [-y]` \| `references/toolbox.md` \|
57	\| `tool` \| 工具箱内 tool 注册与启停（OpenAPI） \| `tool upload --toolbox <id> <openapi-spec>`、`tool list --toolbox <id>`、`tool enable/disable --toolbox <id> <tool-id>...` \| `references/tool.md` \|
58	\| `vega` \| Vega 可观测平台 \| `vega health`, `vega catalog list`, `vega resource list`, `vega query execute -d <json>`, `vega sql --resource-type <t> --query "<sql>"` / `vega sql -d <json>` \| `references/vega.md` \|
59	\| `context-loader` \| MCP 分层检索 \| `context-loader config show`, `context-loader kn-search <query>` \| `references/context-loader.md` \|
60	\| `call` \| 通用 API 调用 \| `call <url> [-X POST] [-d '...']`（可用 `curl` 别名；支持 `--url`、`--data-raw` 等，见 `kweaver --help`） \| `references/call.md` \|
61
62	## 操作指南
63
64	\| 场景 \| 说明 \| 详细参考 \|
65	\|------\|------\|---------\|
66	\| 登录后确认业务域 \| `config show`；若异常或列表为空 → `config list-bd` → `config set-bd <uuid>` \| [references/config.md](references/config.md) \|
67	\| 从数据库/CSV 构建 KN \| 连接数据源 → CSV 导入 → 创建 KN → 构建索引 → 查询验证 → 绑定 Agent \| [references/build-kn-from-db.md](references/build-kn-from-db.md) \|
68	\| CLI 排障速查 \| 权限、pull、

People who liked this also viewed

6 picks

Type