渠道分发安装

版本：2.0.1

AI 助手自动安装

本压缩包包含 kwiki-cli.json 清单文件，AI 助手（如 OpenClaw）可自动识别并执行安装。将本 zip 交给 AI 助手，告诉它"帮我安装"即可。

清单入口：kwiki-cli.json → 执行 node install.js

手动安装

node install.js

安装脚本会自动检测当前平台，从 CDN 下载对应的二进制，通过 npm install -g 安装 CLI，并将 Skill 文件复制到本地 Agent 目录。渠道标识会自动写入 ~/.kwiki-cli/config.json。

使用

# 登录（首次使用）
kwiki-cli auth login

# 查看知识库列表
kwiki-cli kwiki knowledge-view-list

# 检查并更新 Skill
kwiki-cli kwiki skill-update

# 更多命令见本文档下方「工具说明」章节

Kwiki Skills Hub CLI（kwiki-cli）

When to Use（命中关键词）

优先载入并遵循本 skill，当用户表述中出现下列任一意图（不要求用户说出 CLI 名称）：

• 中文：知识库、我的知识库、个人知识库、企业知识库、在知识库里（搜/查/找/问）、知识库问答、从知识库回答、金山/WPS 知识库、zhishi、kwiki。
• 英文：knowledge base、ask the knowledge base、skills hub（与 zhishi/kwiki 同语境时）。
• 要做的事：列出知识库或文件夹、对知识库做智能问答（含可选联网/深度思考）、取分享链接、或做任何 skills_hub 支持的文件/空间管理。

不要做：用户明确只要搜索 当前 Cursor 工作区/本地磁盘 里的文件且未提及云端知识库时——用编辑器搜索工具即可；若用户区分不清，先用简短一问确认是否要 WPS/zhishi 云端知识库。

若 skill 未被自动选中，请让用户在对话中使用 /wps-knowledgebase 或对 wps-knowledgebase skill 使用 @ 附加。

核心概念

• Skills Hub API 前缀：/kwiki/api/v1/skills_hub（由 --base-url 指定站点根，如 https://zhishi.wps.cn）。
• Kwiki 标识（ID）基础：

知识库空间 kuid（均为 0s 开头）：个人与企业编码形态不同，共同点仅为前缀 0s（第 3 个字符不一定是 _）。

• 个人知识库：常见如 0s_3079998078，0s 之后多为 _<drive_id 数字串>，后缀与 drive_id 在数值上一致、可互推。

• 企业知识库：常见如 0sOVd8PU，0s 之后为无数学意义的纯 ID；不要按个人规则把后缀当作 drive_id 解析。

• 树与列表：file-list 等返回的树形结构中，0l 亦可能为文件夹等链接节点；与云文档 fileId 的对应关系以接口返回字段为准。

• 工具形态：所有业务接口挂在 kwiki 子命令下，仅接受 flag，不接受位置参数；输出默认可用 --format pretty 美化 JSON。

鉴权与环境变量

支持多账号（--account，大小写不敏感，不指定则为 default）。每个账号独立存储 token：

kwiki-cli auth login                    # 登录到 default 账号
kwiki-cli auth login --account john     # 登录到 john 账号
kwiki-cli --account john kwiki file-list --kuid <kuid>   # 使用 john 账号的 token

业务代码通过 keychain.GetAccessToken(account) / keychain.SetAccessToken(account, token) 统一读写，不直接拼环境变量或 keyring。SetAccessToken 返回 (storedInKeyring bool, err)：false 且 err==nil 表示已退化为仅本进程环境变量。使用环境变量作降级时，进程需能读到该变量（IDE/子进程若未继承用户环境，会出现「本机已设变量但 CLI 仍无 token」）。已带 token 的请求会携带 X-Kwiki-Auth: <token>。所有对 Kwiki / Skills Hub 的请求还会携带 X-Kwiki-Cli-Ver（CLI 版本号，供服务端统计；npm build:dev / build 构建的二进制会写入发布版本，裸 go build 常为 dev）。所有 kwiki 工具均需 token。

其他常用环境变量：

全局参数

• --base-url：与 KWIKI_BASE_URL 一致，指定 zhishi 根地址。
• --account：token 账号名（不指定为 default）；命名账号环境变量为 X_KWIKI_AUTH_<UPPER>。
• --dry-run / -n（根命令）：对 会改状态 的 kwiki 子命令（RiskWrite / RiskHighRiskWrite，如删除、移动、创建、重命名、上传、知识库关闭等）不发起 HTTP，只打印计划 JSON（含 service、tool、risk、flags、base_url）；此类 --dry-run 不解析 token（便于本地核对 flag）。只读工具（RiskRead）在带 --dry-run 时仍会正常请求（需 token）。
• 各 tool 上的 --format：json（默认）或 pretty。

命令形态

kwiki-cli kwiki <tool> [flags]
kwiki-cli --account <name> kwiki <tool> [flags]
kwiki-cli auth login [--account <name>]
kwiki-cli auth status | logout

工具说明（kwiki-cli kwiki …）

knowledge-view-list — 获取知识库列表

说明：获取知识库列表

kwiki-cli kwiki knowledge-view-list --keyword 项目 --page-size 20

knowledge-view-get — 查询知识库详情

说明：查询知识库详情。--kuid 与 --name 至少填一个。

kwiki-cli kwiki knowledge-view-get --kuid "<kuid>"
kwiki-cli kwiki knowledge-view-get --name "演示"

knowledge-view-create — 创建知识库

说明：创建知识库

kwiki-cli kwiki knowledge-view-create --name "产品库" --desc "简介"

knowledge-view-update — 修改知识库基础配置

说明：用 kuid 定位知识库；只传需要改的字段（未传的字段服务端保留原值）。请求体含 kuid（必填）及可选 cover_img、name、desc。

kwiki-cli kwiki knowledge-view-update --kuid "<kuid>" --cover-img "https://zl.wpscdn.cn/2025/06/09/other/4.png" --name "新名称"
kwiki-cli kwiki knowledge-view-update --kuid "<kuid>" --desc "新简介"

knowledge-view-close — 关闭知识库

说明：关闭知识库(根据知识库的kuid)

kwiki-cli kwiki knowledge-view-close --kuid "<kuid>"

knowledge-view-share-link — 获取知识库分享链接

说明：GET knowledge_view/share_link，查询参数 kuid。

kwiki-cli kwiki knowledge-view-share-link --kuid "<kuid>"

knowledge-view-ask — 智能问答

说明：POST knowledge_view/ask，服务端以 text/event-stream 流式返回。CLI 默认将 SSE 增量片段（尤其 answer_citations[].text）拼接为完整答案后，按 --format json|pretty 输出单个 JSON 对象，便于 Agent 直接消费。需要原始 SSE 时加 --stream。

Body 含 input；可选 kuids（重复 --kuid）、scope（未传 --kuid 时 CLI 自动设 all_wiki）、use_web_search（--web-search）、switch_thinking（--switch-thinking，深度思考）。

kwiki-cli kwiki knowledge-view-ask --input "你的问题"
kwiki-cli kwiki knowledge-view-ask --input "你的问题" --kuid "<kuid>" --web-search --switch-thinking
kwiki-cli kwiki knowledge-view-ask --input "你的问题" --stream   # 原始 SSE

输出字段：聚合后常见 answer_citations（text 为完整答案，reply_sources / citations 等为引用来源）；亦可能含 query、process_display 等元数据。

skill-update — 检查并更新 SKILL.md

说明：复用 GET /kwiki/api/v1/skills_hub/skill?skill_name=kwiki&version=latest 获取最新 SKILL 版本，CLI 端比较版本号后自动写入各 Agent 的 wps-knowledgebase skill 目录（Cursor、Claude Code、OpenClaw、Kimi）。无需鉴权。

kwiki-cli kwiki skill-update
kwiki-cli kwiki skill-update --check-only

file-list — 查询知识库或文件夹内文件列表

说明：查询知识库或文件夹里面的文件列表(包括文件和文件夹)

kwiki-cli kwiki file-list --kuid "<kuid>" --format pretty

file-create — 创建知识库文件或文件夹

说明：创建知识库文件或文件夹

kwiki-cli kwiki file-create --doc-type folder --kuid "<parent_kuid>" --title "归档"

file-delete — 删除知识库文件或文件夹

说明：知识库删除文件或文件夹。删除后进入回收站，可在期限内到 https://www.kdocs.cn/enttrash/0 等进行恢复。

kwiki-cli kwiki file-delete --kuid "<kuid>"

file-rename — 重命名文件或文件夹

说明：重命名文件或文件夹

kwiki-cli kwiki file-rename --kuid "<kuid>" --title "新标题"

file-download — 下载文件

说明：下载文件, 根据kuid(仅支持文件), 提供两种返回格式, download_link或file_base64(推荐)。请求体始终含 kuid；仅当传入 --response-type 时才附带 response_type。不传 response_type 则由服务端默认。

限制：OTL 智能文档（doc_origin_type 为 otl / doc_type 为 o 等）不支持通过本接口下载；调用 file-download（含 file_base64、download_link）会返回业务错误（如 400408000）。需取内容时请改用其它导出或转换能力，勿对 OTL 走 file-download。

kwiki-cli kwiki file-download --kuid "<file_kuid>"
kwiki-cli kwiki file-download --kuid "<file_kuid>" --response-type file_base64

file-convert — 文件格式转换

说明：将指定格式的内容转换为目标格式的文件。目前仅支持 md -> otl（Markdown 转智能文档）。请求体始终含 kuid、title、content；仅当传入 --from / --to 时才附带对应字段。

kwiki-cli kwiki file-convert --kuid "<kb_kuid>" --title "说明" --content "# 标题\n正文"
kwiki-cli kwiki file-convert --kuid "<kb_kuid>" --title "说明" --content "# 标题" --from md --to otl

file-move — 移动知识库文件或文件夹

说明：移动知识库的文件或文件夹；请求体含 drive_id、dest_drive_id、space_kuid、file_kuids 等。drive_id / kuid 可从 knowledge-view-list 等接口返回获取。

kwiki-cli kwiki file-move --drive-id b --dest-drive-id c --space-kuid d --file-kuid f1 --file-kuid f2

file-import — 导入云文档到知识库

说明：导入云文档文件到知识库。请求体使用 file_ids 数组；CLI 用重复 --file-id 传入多个 id。

kwiki-cli kwiki file-import --kuid "<folder_kuid>" --action copy --file-id id1 --file-id id2

file-upload — 本地上传（multipart）

说明：POST /skills_hub/skill/file/upload（multipart，本地上传）。用于本机文件上传到知识库侧的补充场景。

kwiki-cli kwiki file-upload --drive-id "<drive_id>" --file ./a.docx

常用工作流示例

查看 kwiki-cli 使用说明（skill 文档）

Skill 正文随 @ks-personal/kwiki-cli npm 包内的 skills/wps-knowledgebase/SKILL.md 分发；也可在本仓库 skills/wps-knowledgebase/SKILL.md 直接阅读。CLI 版本以 package.json / npm 为准。

浏览知识库根目录再进入子文件夹

kwiki-cli kwiki file-list --kuid "<space_kuid>"
kwiki-cli kwiki file-list --kuid "<folder_0l_kuid>" --page-size 50

新建文件夹并导入云文档

kwiki-cli kwiki file-create --doc-type folder --kuid "<space_kuid>" --title "资料"
kwiki-cli kwiki file-import --kuid "<new_folder_kuid>" --action shortcut --file-id "<cloud_file_id>"

列表 / 详情 / 分享 / 问答 / 关闭知识库

kwiki-cli kwiki knowledge-view-list --keyword 团队
kwiki-cli kwiki knowledge-view-get --kuid "<kuid>"
kwiki-cli kwiki knowledge-view-share-link --kuid "<kuid>"
kwiki-cli kwiki knowledge-view-ask --input "问题" --kuid "<kuid>"
kwiki-cli kwiki knowledge-view-close --kuid "<kuid>"

检查并更新 Skill

kwiki-cli kwiki skill-update
kwiki-cli kwiki skill-update --check-only

提示

• 命令形态：所有 kwiki-cli kwiki <tool> 只接受 flag，不接受位置参数；多余参数会报错。
• 鉴权：所有 kwiki 工具需 keychain.GetAccessToken(account) 能解析到 token（优先 keyring，对应环境变量降级；默认 X_KWIKI_AUTH，命名账号 X_KWIKI_AUTH_<UPPER>）。写操作前确认与 --base-url 指向正确环境。
• 全局：根命令持久化 --base-url（或 KWIKI_BASE_URL）、--account；各 tool 上 --format json|pretty 控制输出（knowledge-view-ask 默认聚合 SSE 为 JSON；加 --stream 时透传原始 SSE）。
• npm / skills：安装后若本机 Agent skills 目录未更新，可执行 kwiki-cli setup（逻辑在 scripts/setup.js，支持 --global、--target 等）。

常用工作流

> 详细流程与命令示例参见 references/workflow.md。

详细参考文档

references/ 目录按主题拆分了详细参考，执行对应场景时按需加载，避免一次性读取过多内容。