zsxq-shared
unnoo/zsxq-skill
知识星球 CLI 共享基础:认证、API 调用、链接拼接、错误处理
What is zsxq-shared?
提供知识星球 CLI 的核心认证、API 调用、链接生成和错误处理规范。用于首次登录、调用底层接口、生成分享链接或排查认证和 HTTP 错误时参考。
- OAuth 2.0 设备授权码流程认证(login/logout/status)
- 配置诊断与版本查看(doctor/config show)
- 通用 API 调用规范(api list/api call/api raw)
- 知识星球与主题分享链接拼接(电脑端/手机端)
- 写入删除操作安全规则与确认流程
- 常见错误码处理(401/403/404/参数缺失/格式错误)
How to install zsxq-shared
npx skills add https://github.com/unnoo/zsxq-skill --skill zsxq-shared- 已安装 zsxq-cli
How to use zsxq-shared
- 1.运行 `zsxq-cli auth login` 启动 OAuth 授权流程,在浏览器完成授权
- 2.运行 `zsxq-cli auth status` 查看当前登录账户
- 3.运行 `zsxq-cli api list` 列出所有可用底层接口工具
- 4.使用 `zsxq-cli api call <tool> --params '<json>'` 调用接口工具
- 5.使用 `zsxq-cli api raw --method <METHOD> --path <PATH>` 调用原始 HTTP 接口
- 6.根据 group_id 和 topic_id 拼接分享链接(电脑端/手机端)
- 7.遇到错误时参考常见错误处理表进行排查
Use cases
- 首次使用时通过 OAuth 流程登录知识星球账户
- 调用底层接口工具或原始 HTTP 接口获取或修改数据
- 生成主题或星球的分享链接供用户分享
- 排查认证失败、权限不足或资源不存在等错误
- 诊断 CLI 配置与 Keychain 认证状态
- 知识星球 CLI 用户
- 需要集成知识星球 API 的开发者
- 通过 AI Agent 操作知识星球资源的用户
zsxq-shared FAQ
Token 存储在系统 Keychain 中,永久有效,禁止在终端明文输出或分享。
列表/查询类操作优先使用 api call(如 get_group_topics),api raw 主要用于 api call 尚未覆盖的写入接口或直接 HTTP 调用。
使用上一页 JSON 中返回的 next_end_time 或 create_time 原值作为 --end-time 参数,不要手动修改格式。
Token 无效或过期,运行 `zsxq-cli auth login` 重新登录。
必须确认用户意图,不确定 ID 时先用查询命令确认,再执行写入或删除操作。
Full instructions (SKILL.md)
Source of truth, from unnoo/zsxq-skill.
name: zsxq-shared version: 1.3.1 description: "知识星球 CLI 共享基础:认证登录(auth login/logout/status)、配置诊断(doctor/config show)、通用 API 调用规范(api list/api call/api raw 调用底层接口或原始 HTTP 接口)、星球与主题分享链接拼接(电脑端 / 手机端)、写入与删除操作的安全规则、常见错误码处理(401 token 过期、缺参数等)。当用户首次登录、退出登录、查看认证状态、调用 zsxq-cli api raw / api call、需要拼接知识星球分享链接,或遇到认证或 HTTP 错误时使用。" metadata: requires: bins: ["zsxq-cli"] cliHelp: "zsxq-cli auth --help"
zsxq-cli 共享规则
本技能指导你如何通过 zsxq-cli 操作知识星球资源,以及有哪些注意事项。
索引
- Commands — 认证、诊断、底层 API 调用命令一览
- 认证 — OAuth 设备授权码流程
- 直接调用 API —
api call/api raw详细用法与示例 - 链接拼接 — 主题/星球分享链接(电脑端 / 手机端)
- 安全规则 — Token、写入确认、ID 查询前置
- 反馈提醒(NPS) — 何时主动建议用户提交 NPS 反馈
- 常见错误处理 — 通用错误(401/403/404/参数缺失/分页时间格式)
Commands
| 命令 | 说明 |
|---|---|
zsxq-cli auth login | OAuth 设备授权码登录(首次使用、token 过期或切换账户时) |
zsxq-cli auth status | 查看当前登录账户(默认表格,加 --json 输出 JSON) |
zsxq-cli auth logout | 清除本地凭据 |
zsxq-cli doctor | 诊断 CLI 配置与 keychain 认证状态 |
zsxq-cli config show | 显示版本信息与当前配置(加 --json 输出 JSON) |
zsxq-cli api list | 列出所有可用底层接口工具及参数 |
zsxq-cli api call <tool> | 调用底层接口工具,需配 --params '<json>' |
zsxq-cli api raw | 直接调用原始 HTTP 接口(需 --method --path) |
详细用法见下面各小节。
认证
zsxq-cli 使用 OAuth 2.0 设备授权码流程(RFC 8628) 认证,token 存储在系统 Keychain 中,永久有效。
OAuth 登录流程
zsxq-cli auth login 启动后:
- 命令输出一个
verification_uri链接和user_code - 用户在手机或浏览器中打开链接,完成授权
- CLI 自动轮询,授权完成后自动保存 token
当你作为 AI Agent 帮用户登录时,在后台运行
zsxq-cli auth login,读取输出后将授权链接提供给用户,等待用户完成授权。
直接调用 API
当 Shortcut 无法满足需求时,可以直接调用底层接口(参数与方法见上面 Commands 表)。
api call 示例:
zsxq-cli api call get_self_info --params '{}'
zsxq-cli api call search_groups --params '{"keyword":"Go语言"}'
# 跨星球查询当前用户主题足迹(不传 group_id 即查所有星球)
zsxq-cli api call get_user_footprints --params '{"user_id":"123456"}'
# 限定单个星球
zsxq-cli api call get_user_footprints --params '{"user_id":"123456","group_id":"123456789"}'
api raw 示例:
zsxq-cli api raw --method GET --path /v3/users/self
# --body 支持简写,自动包装 req_data
zsxq-cli api raw --method PUT --path /v2/topics/123 --body '{"text":"新内容"}'
列表/查询类操作请优先使用
api call(如get_group_topics),api raw主要用于api call尚未覆盖的写入接口。
api raw响应已去除三层嵌套,直接返回数据内容。
链接拼接
当用户需要分享链接时,使用以下模板拼接。输出时同时提供电脑端和手机端两个版本。
主题链接
- 电脑端:
https://wx.zsxq.com/group/{group_id}/topic/{topic_id} - 手机端:
https://wx.zsxq.com/mweb/views/topicdetail/topicdetail.html?topic_id={topic_id}&group_id={group_id}
星球链接
- 电脑端:
https://wx.zsxq.com/group/{group_id} - 手机端:
https://wx.zsxq.com/mweb/views/topic/topic.html?group_id={group_id}
安全规则
- Token 是登录凭证,禁止在终端明文输出或分享给他人
- 写入/删除操作前必须确认用户意图(发帖、编辑、评论、回答、创建笔记、删除主题或笔记、提交 NPS 反馈等)
- 不确定 group_id / topic_id / note_id 时,先用查询命令确认,再执行写入或删除
反馈提醒(NPS)
当用户在使用 zsxq-* skill 过程中遇到「适合反馈给知识星球官方」的场景时,AI 应在完成主任务后顺带一句提示用户考虑提交 NPS 反馈(zsxq-cli user +nps)。
触发场景
| # | 场景 | 信号 | 标签 |
|---|---|---|---|
| 1 | 用户表达对知识星球产品本身的不满 | 自然语言:抱怨产品规则 / 抱怨体验 / 「这功能怎么这么难用」 | #产品建议# |
| 2 | 用户的需求知识星球产品侧不存在能力 | AI 排查后确认接口/能力在产品上根本没有(不是 CLI 没封装) | #产品建议# |
| 3 | zsxq-cli / skill 工具侧未封装 | api list 中找不到对应工具,且 api raw 也无现成 path | #工具反馈# |
| 4 | 同一命令多次重试仍失败、用户明显受挫 | 同一会话内对同一目标的命令连续失败 ≥ 3 次,且失败原因不属于排除清单 | #工具反馈# |
排除场景(不触发提示)
下列错误属于「用户自查可解 / 状态类错误」,应走对应的解决路径而非反馈,与下面 ## 常见错误处理 表对齐:
401/not logged in→ 引导auth login403/ 无权限 → 提示切换账户或加入星球404/ 资源不存在 → 重新核对 ID--<flag> is required等参数缺失 → 用查询命令补齐--end-time解析失败等格式错误 → 参见下面 ## 常见错误处理 表的格式说明
提示流程
[1] 命中触发场景
[2] AI 一句话提示(不打断主任务)
示例:"顺带一提:刚刚这个场景比较适合反馈给知识星球官方,
你需要的话我可以帮你提交一条 NPS 反馈。"
[3] 用户拒绝 → 回到主任务,会话内不再提
用户接受 ↓
[4] AI 协助起草:
- 询问 score(1–10),不自动赋值
- 起草 suggestion(≤ 500 字),以 #产品建议# 或 #工具反馈# 开头
- 把 score 与 suggestion 全文复述给用户确认
[5] 用户确认 → 执行 zsxq-cli user +nps
用户改稿 → 回到 [4] 修订
关键约束
- 每会话最多 1 次:同一会话内只提示一次;发过就不再主动重复,除非用户后续主动询问。
- 附带不替代:第 [2] 步是附带的,不能让反馈提示中断或替换主任务的解决路径。先解决用户的事,再顺口提一句。
- score 必须问用户:第 [4] 步起草不替代用户判断,score 不能自动赋值。
- suggestion 必须复述确认:AI 起草后必须把 score 与 suggestion 全文复述给用户确认,用户改稿后回 [4] 修订。
- tag 写在 suggestion 正文开头:
#产品建议#/#工具反馈#不占用 score 字段,让官方读到原文时就有分流标记。
详见 zsxq-user-nps。
常见错误处理
下表覆盖所有 zsxq-cli 命令通用的错误。各命令的 reference 文档只列出与该命令直接相关的特殊错误(如 --score must be 1–10、code: 100262 无权限删除),通用错误一律回到这里。
| 错误 | 原因 | 解决方案 |
|---|---|---|
authentication failed (HTTP 401) / not logged in | Token 无效、过期或未登录 | 运行 zsxq-cli auth login 重新登录 |
| 403 / 无权限 / 不可访问 | 当前账户无访问目标资源的权限 | 切换到正确账户,或加入对应星球后重试 |
| 404 / 资源不存在 | group_id / topic_id / note_id 等无效或对应资源已被删除 | 重新核对 ID;可用 group +list、topic +search、note +list 等查询 |
--<flag> is required | 缺少必填参数 | 用对应查询命令获取后再填,例如 group_id 用 group +list、topic_id 用 topic +search |
--end-time 解析失败 | 分页时间格式错误 | 使用上一页 JSON 中返回的 next_end_time / create_time 原值 |
Related skills
More from unnoo/zsxq-skill and the wider catalog.

zsxq-topic
Manage Knowledge Planet topics: search, create, edit, comment, answer questions, and moderate content.

zsxq-note
Manage shareable public notes on 知识星球 (Zhihu Planet) with create, edit, view, and delete operations.

zsxq-group
Manage 知识星球 (Zhihu Knowledge Planet) groups: list, browse topics, query tags, search members.

zsxq-user
View 知识星球 user profile, cross-sphere topic footprints, and submit NPS feedback.