Confluence CLI (confcli)

📑 Confluence 云文档命令行管家

Atlassian Confluence Cloud 官方风格 CLI 工具,支持页面 CRUD、附件管理、标签与评论操作,适合 DevOps 与文档工程师自动化文档工作流。

收藏
6.4k
安装
1.5k
版本
0.2.5
CLS 安全扫描中
预计需要 3 分钟...

使用说明

综合评估

confcli 是由社区开发者 hochej 维护的命令行工具,专为 Atlassian Confluence Cloud 设计,提供了一套完整的文档生命周期管理能力。该工具采用 Go 语言开发,通过官方 REST API 与 Confluence 交互,支持页面创建、更新、删除、搜索、导出,以及附件上传下载、标签管理和评论操作等全功能覆盖。

核心用法

工具设计遵循 Unix 哲学,命令结构清晰:confcli <资源> <动作> <标识符> [选项]。资源类型涵盖 space、page、attachment、label、comment 等,支持多种页面引用方式(ID、URL、Space:Title 格式)。输出格式灵活,可通过 -o 参数切换 JSON、表格或 Markdown 格式,便于脚本集成和人工阅读。特色功能包括 copy-tree 递归复制页面树、export 批量导出、--dry-run 预览破坏性操作,以及与 $EDITOR 集成的交互式编辑。

显著优点

1. 功能完整性:覆盖 Confluence Cloud 核心 API 能力,单工具即可替代多脚本方案
2. 身份安全设计:强制通过环境变量或交互式登录配置认证,明确禁止在对话中传输敏感令牌

3. 操作可审计:所有写操作需显式确认,配合 --dry-run 降低误操作风险

4. 引用灵活性:Space:Title 等简洁引用方式大幅提升命令行操作效率

5. 输出可控性:JSON/表格/Markdown 多格式输出适配 CI/CD、报告生成等场景

潜在局限

  • 生态成熟度:作为个人开源项目(GitHub hochej/confcli),长期维护稳定性存疑,社区贡献度待观察
  • 平台限制:仅支持 Confluence Cloud,不兼容 Confluence Server/Data Center 版本
  • 安装风险:官方推荐通过远程脚本 curl | sh 安装,存在供应链安全风险,建议校验签名后使用
  • 权限粒度:依赖 API Token 的权限范围,无法突破 Confluence 原生权限模型

适合人群

  • DevOps 工程师:构建文档即代码(Docs as Code)流水线,实现 Confluence 内容与 Git 仓库同步
  • 技术写作团队:批量创建标准化页面模板、自动化版本发布说明归档
  • 项目经理:批量导出空间内容用于离线审阅或合规审计
  • CI/CD 集成:在部署流程中自动更新运维手册、API 文档

常规风险

| 风险类型 | 说明 |
|---------|------|
| 认证泄露 | API Token 拥有账户全部权限,需严格管控环境变量作用域 |
| 误删数据 | `delete`、`purge`、`copy-tree` 等操作不可逆,务必先用 `--dry-run` 验证 |
| 权限越界 | 工具不校验操作者权限,执行前需确认 Confluence 空间管理员身份 |
| API 限流 | 大规模批量操作可能触发 Atlassian 速率限制,建议配合 `--all` 与分页参数谨慎使用 |

Confluence CLI (confcli) 内容

手动下载zip · 3.0 kB
skill-card.mdtext/markdown
请选择文件