核心用法
confluence-cli 是一款基于 Node.js 的命令行工具,通过 Atlassian REST API 与 Confluence 实例交互。核心操作包括:
- 搜索与导航:
confluence search全文检索页面,confluence spaces列出所有空间,confluence find按标题定位页面 - 内容读取:
confluence read获取页面正文,confluence info查看元数据,confluence children列出子页面 - 内容管理:
confluence create/create-child创建页面,confluence update更新内容,支持--body直接输入或--file从文件加载 - 数据导出:
confluence export将页面及附件打包到本地目录
显著优点
1. 高效批量操作:避免 Web 界面繁琐点击,适合批量创建文档、自动化发布流程
2. 版本控制友好:页面内容可作为 Markdown/HTML 文件纳入 Git 管理,再推送至 Confluence
3. CI/CD 集成:可在部署流水线中自动更新发布说明、API 文档
4. 存储格式支持:原生支持 Confluence Storage Format(XHTML 子集),保留宏和结构化内容
潜在缺点与局限性
- Token 权限边界:API token 继承创建者权限,无法突破 Confluence 空间权限限制
- 格式转换负担:Storage Format 与普通 HTML/Markdown 存在差异,复杂页面可能需要手动调整
- 企业版限制:部分高级功能(如页面模板、审批流程)无法通过 CLI 操作
- 错误反馈简略:命令行错误信息不如 Web 界面直观,调试权限问题较困难
适合人群
- 技术团队文档管理员、DevOps 工程师、需要批量维护 wiki 的开发者
- 希望将文档源码化(docs-as-code)的敏捷团队
常规风险
| 风险类型 | 说明 |
|---------|------|
| 权限失控 | Token 泄露可导致整个 Confluence 实例被篡改或数据导出 |
| 内容覆盖 | `update` 操作无内置版本对比,可能意外覆盖他人修改 |
| 配置泄露 | `~/.confluence-cli/config.json` 存储凭证,需确保文件权限 600 |
| API 限流 | 大量操作可能触发 Atlassian 速率限制 |
建议配合环境变量 CONFLUENCE_TOKEN 使用,避免硬编码凭证;生产环境操作建议先在沙箱空间验证。