核心用法
confluence-v2 是一个针对 Confluence Cloud REST API v2 的完整技能封装,提供对 Pages、Spaces、Folders、Databases、Whiteboards、Comments、Labels、Tasks、Properties 等全部资源组的原生访问能力。用户通过环境变量配置 Basic(邮箱+API Token)或 OAuth 2.0 认证后,即可使用 scripts/ 目录下的模块化脚本执行 CRUD 操作。
主要功能模块
- pages.js: 页面创建、查询、更新、删除
- spaces.js: 空间管理与列表遍历
- folders.js: 层级目录操作(含直接子项查询)
- databases.js / whiteboards.js: 新型数据结构支持
- comments.js / labels.js / tasks.js: 协作功能完整覆盖
- call.js: 透传任意 API 端点,支持 ad-hoc 调试
显著优点
1. API v2 完整覆盖: 相比 legacy CLI,全面支持 Atlassian 主推的 v2 端点(数据库、白板等新资源类型)
2. 双认证体系: Basic Auth 适合自动化脚本,OAuth 适合用户态集成,均通过标准 HTTP 头实现
3. 分页内建: client.js 自动处理 Confluence 的分页 cursor,简化大数据集遍历
4. 平滑迁移: 自动识别 ~/.confluence-cli/config.json 配置格式,降低存量用户切换成本
潜在局限与风险
- 权限依赖严格: 所有操作受限于 Confluence 站点权限模型,API Token 需具备对应空间的管理权限
- Premium/Enterprise 功能限制: Admin Key Header 仅高级版可用,免费/标准版用户无法使用组织级管理接口
- OAuth Token 生命周期: 需自行处理刷新逻辑,技能本身不提供 token 自动续期
- Base URL 硬编码模式: 强制要求
atlassian.net/wiki域名结构,私有化部署(Data Center)不支持
适合人群
- DevOps/SRE 团队:批量页面生成、空间结构自动化管理
- 知识库管理员:跨空间内容迁移、标签体系规范化
- 集成开发者:构建与 Confluence 数据双向同步的第三方应用
常规风险提示
⚠️ 生产数据操作不可逆: DELETE 操作直接作用于云端,建议先在沙箱空间验证脚本
⚠️ Token 安全存储: API Token 等效于账户密码,禁止使用明文提交至版本控制
⚠️ 速率限制: Atlassian 实施严格的 API 配额(通常 1000 req/5min),批量任务需内置退避重试