@cloudglab/confluence-cli 0.0.4 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/README.md +5 -0
- package/dist/install.js +11 -2
- package/dist/manifest.json +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/skills/confluence-cli/SKILL.md +63 -0
- package/skills/confluence-cli/reference/cli.md +36 -0
- package/skills/confluence-cli/reference/commands.md +41 -0
- package/skills/confluence-cli/reference/content.md +23 -0
- package/skills/confluence-cli/reference/overview.md +23 -0
- package/skills/confluence-cli/reference/rest.md +19 -0
- package/skills/confluence-cli/reference/transfer.md +27 -0
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
|
|
5
|
+
## 0.0.5 - 2026-06-17
|
|
6
|
+
|
|
7
|
+
### 修复
|
|
8
|
+
|
|
9
|
+
- `install` / `update` 链路:把仓库内 `skills/confluence-cli` 从指向 `.agents/skills/confluence-cli` 的符号链接替换为真实目录副本,避免 npm tarball 中 `skills/confluence-cli` 路径在用户机器上不可用导致“未找到已安装包内的 Confluence skill”错误。
|
|
10
|
+
- `install` / `update` 链路:`installMmdCli` 不再因 `curl -fsSL ... | sh` 网络失败而中断整个安装,改为捕获异常并输出 `已跳过 mmd-cli 安装:<原因>` 与后续 `--mermaid none` 退路提示。
|
|
11
|
+
- `install` / `update` 链路:`installSkillFromInstalledPackage` 在 `access` 失败时不再直接抛错,自动回退到 `installSkillFromNpmPackage`(`npm pack` + `tar -xzf` + `npx -y skills add`),覆盖包内 skill 缺失场景。
|
|
12
|
+
|
|
13
|
+
### 测试
|
|
14
|
+
|
|
15
|
+
- `tests/install.test.ts` 新增回归用例 `本地 skill 缺失时自动回退到 npm 包解压安装,mmd-cli 失败不阻断安装`:mock `curl` 退出码 35、stderr 含 `curl: (35) LibreSSL SSL_connect...`,断言安装链路按 `npm install -g` → 跳过 `mmd-cli` → `npm pack` → `tar` → `npx -y skills add` 顺序完成,并校验 stdout 中包含“已跳过 mmd-cli 安装”与“正在自动回退到 npm 包解压安装”两行提示。
|
|
16
|
+
|
|
17
|
+
### 说明
|
|
18
|
+
|
|
19
|
+
- 本次热修不改变 `mmd-cli` 运行时仍需系统 Chrome/Chromium 的前提;网络环境下无法自动安装 `mmd-cli` 时,建议用户改用 `--mermaid none` 保留代码块。
|
|
20
|
+
- 验证结果:`pnpm test -- tests/install.test.ts tests/skill.test.ts tests/tools/transfer.test.ts` 全部通过(3 个文件、10 个测试)。
|
|
21
|
+
|
|
5
22
|
## 0.0.4 - 2026-06-17
|
|
6
23
|
|
|
7
24
|
### 修复
|
package/README.md
CHANGED
|
@@ -25,6 +25,11 @@ pnpm release:smoke-query --dry-run
|
|
|
25
25
|
|
|
26
26
|
`mmd-cli` 运行时仍需要系统已有 Chrome/Chromium;如果机器完全没有浏览器,可在上传时传 `--mermaid none`,保留 Mermaid 代码块。
|
|
27
27
|
|
|
28
|
+
从 `0.0.5` 起,`install` / `update` 在以下两种情况会**继续完成安装**而不是中断:
|
|
29
|
+
|
|
30
|
+
- `mmd-cli` 官方安装脚本因网络问题失败时,会打印 `已跳过 mmd-cli 安装:<原因>` 与 `后续如需 Mermaid 图片渲染,可稍后重试安装,或在上传时传 --mermaid none 保留代码块。`。
|
|
31
|
+
- 全局包内 `skills/confluence-cli` 缺失时,会打印 `未找到已安装包内的 Confluence skill:<path>,正在自动回退到 npm 包解压安装...` 并自动用 `npm pack` + `tar` + `npx -y skills add` 完成 skill 安装,无需手动切换 `--skill-source npm`。
|
|
32
|
+
|
|
28
33
|
安装/更新入口:
|
|
29
34
|
|
|
30
35
|
```bash
|
package/dist/install.js
CHANGED
|
@@ -246,7 +246,14 @@ async function installGlobalCli(action) {
|
|
|
246
246
|
}
|
|
247
247
|
}
|
|
248
248
|
async function installMmdCli(action) {
|
|
249
|
-
|
|
249
|
+
try {
|
|
250
|
+
await runStep(`${action} Mermaid 原生渲染器 mmd-cli`, "sh", ["-c", `curl -fsSL ${MMD_CLI_INSTALL_URL} | sh`]);
|
|
251
|
+
}
|
|
252
|
+
catch (error) {
|
|
253
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
254
|
+
process.stdout.write(`已跳过 mmd-cli 安装:${message}\n`);
|
|
255
|
+
process.stdout.write("后续如需 Mermaid 图片渲染,可稍后重试安装,或在上传时传 --mermaid none 保留代码块。\n");
|
|
256
|
+
}
|
|
250
257
|
}
|
|
251
258
|
function isNpmDirectoryNotEmptyError(error) {
|
|
252
259
|
const message = error instanceof Error ? error.message : String(error);
|
|
@@ -286,7 +293,9 @@ async function installSkillFromInstalledPackage(action, skillGlobal) {
|
|
|
286
293
|
await access(skillPath);
|
|
287
294
|
}
|
|
288
295
|
catch {
|
|
289
|
-
|
|
296
|
+
process.stdout.write(`未找到已安装包内的 Confluence skill:${skillPath},正在自动回退到 npm 包解压安装...\n`);
|
|
297
|
+
await installSkillFromNpmPackage(action, skillGlobal);
|
|
298
|
+
return;
|
|
290
299
|
}
|
|
291
300
|
await runNpxStepWithRetry(`${action} Confluence skill`, createSkillAddArgs(skillPath, skillGlobal));
|
|
292
301
|
}
|
package/dist/manifest.json
CHANGED
package/dist/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const VERSION = "0.0.
|
|
1
|
+
export declare const VERSION = "0.0.5";
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = "0.0.
|
|
1
|
+
export const VERSION = "0.0.5";
|
|
2
2
|
//# sourceMappingURL=version.js.map
|
package/package.json
CHANGED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: confluence-cli
|
|
3
|
+
description: Use this CLI for Confluence REST operations from a terminal or agent workflow. Triggers on Confluence page search, read, upload (Markdown/HTML with Mermaid + TOC), download, labels, attachments, comments, and Confluence 7.13.7 REST pass-through.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Confluence CLI Skill
|
|
7
|
+
|
|
8
|
+
Use this CLI when a task needs Confluence REST operations from a terminal or agent workflow.
|
|
9
|
+
|
|
10
|
+
Start with these references when you need details:
|
|
11
|
+
|
|
12
|
+
- `reference/overview.md`:整体工作流与安全原则
|
|
13
|
+
- `reference/commands.md`:命令速查
|
|
14
|
+
- `reference/cli.md`:安装、更新、角色入口和环境变量
|
|
15
|
+
- `reference/content.md`:页面查询、读取、子页、评论、标签
|
|
16
|
+
- `reference/transfer.md`:Markdown/HTML 发布、下载、附件、Mermaid/TOC
|
|
17
|
+
- `reference/rest.md`:Confluence 7.13.7 REST 端点透传
|
|
18
|
+
- `../../docs/release.md`:发布前检查与 npm 发布流程
|
|
19
|
+
|
|
20
|
+
## Decision Matrix
|
|
21
|
+
|
|
22
|
+
- Read/search small content: `confluence searchContent` or `confluence getContent`.
|
|
23
|
+
- Convert Markdown locally: `confluence convertMarkdownToWiki`.
|
|
24
|
+
- Generate mark metadata: `confluence generateMarkMetadata`.
|
|
25
|
+
- Upload large Markdown through REST: `confluence uploadMarkdown --toc --confirm true`.
|
|
26
|
+
- Upload raw HTML through REST: `confluence uploadHtml --toc --confirm true`.
|
|
27
|
+
- For full page publishes or republish flows, include `--toc` by default; only omit it when the user explicitly says no TOC.
|
|
28
|
+
- Upload Markdown with attachments: `confluence uploadMarkdown --attachments '["a.png"]' --toc --confirm true`.
|
|
29
|
+
- Dry-run uploads first: omit `--confirm true`.
|
|
30
|
+
- Render Mermaid on the fly: any ```mermaid fence in Markdown/HTML auto-generates PNG attachments by default.
|
|
31
|
+
- Download editable backup: `confluence downloadPage`.
|
|
32
|
+
- Download page with attachments/children: `confluence downloadPage --downloadAttachments true --downloadChildren true`.
|
|
33
|
+
- Use MCP-style page tools: `getPageChildren`, `getComments`, `addComment`, `getLabels`, `addLabels`.
|
|
34
|
+
- Use attachment tools: `listAttachments`, `uploadAttachment`, `updateAttachment`, `downloadAttachment`.
|
|
35
|
+
- Check PAT identity: `confluence getCurrentUser`.
|
|
36
|
+
|
|
37
|
+
## Safety
|
|
38
|
+
|
|
39
|
+
All writes must pass `--confirm true`. Without confirmation, upload, delete, label, comment and attachment write commands return a dry-run preview.
|
|
40
|
+
|
|
41
|
+
## CQL Examples
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
confluence searchContent --cql 'space = "DEV" AND text ~ "API"'
|
|
45
|
+
confluence searchContent --cql 'type = page AND title ~ "Runbook"'
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Upload Patterns
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
# Markdown → Confluence,自动 Mermaid → PNG 附件图片,默认注入双 TOC 宏
|
|
52
|
+
confluence uploadMarkdown --file doc.md --id 142552620 --toc --tocMaxLevel 3 --confirm true
|
|
53
|
+
|
|
54
|
+
# 保持原代码块不渲染
|
|
55
|
+
confluence uploadMarkdown --file doc.md --id 142552620 --mermaid none --toc --confirm true
|
|
56
|
+
|
|
57
|
+
# HTML → Confluence,同样支持Mermaid和TOC
|
|
58
|
+
confluence uploadHtml --file page.html --space DEV --toc --confirm true
|
|
59
|
+
|
|
60
|
+
# 只预览(dry-run)
|
|
61
|
+
confluence uploadMarkdown --file doc.md --id 142552620 --toc
|
|
62
|
+
confluence uploadHtml --file page.html --space DEV --toc
|
|
63
|
+
```
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# CLI
|
|
2
|
+
|
|
3
|
+
## 安装与更新
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
confluence install --skip-config-check true
|
|
7
|
+
confluence update --skip-config-check true
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
可选参数:
|
|
11
|
+
|
|
12
|
+
- `--skill-source local|git|npm`
|
|
13
|
+
- `--skill-local-path <dir>`
|
|
14
|
+
- `--cli-only true|false`
|
|
15
|
+
- `--skill-only true|false`
|
|
16
|
+
- `--skip-config-check true|false`
|
|
17
|
+
|
|
18
|
+
## 角色入口
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
confluence list
|
|
22
|
+
confluence-reader list
|
|
23
|
+
confluence-writer list
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
- `confluence`:完整入口。
|
|
27
|
+
- `confluence-reader`:不注册发布上传类 transfer 命令。
|
|
28
|
+
- `confluence-writer`:注册写入和发布命令,但仍需要 `--confirm true`。
|
|
29
|
+
|
|
30
|
+
## 环境变量
|
|
31
|
+
|
|
32
|
+
- `CONFLUENCE_URL`
|
|
33
|
+
- `CONFLUENCE_PAT` 或 `CONFLUENCE_PERSONAL_TOKEN`
|
|
34
|
+
- `CONFLUENCE_USERNAME` + `CONFLUENCE_PASSWORD`
|
|
35
|
+
- `CONFLUENCE_DISABLE_WRITE=true`
|
|
36
|
+
- `CONFLUENCE_SKIP_UPDATE_CHECK=true`
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# 命令速查
|
|
2
|
+
|
|
3
|
+
## 基础
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
confluence help
|
|
7
|
+
confluence list
|
|
8
|
+
confluence version
|
|
9
|
+
confluence help searchContent
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## 配置
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
confluence initConfluence --url https://confluence.example.com --pat TOKEN --save true
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## 查询
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
confluence searchContent --cql 'space = "DEV" AND text ~ "API"'
|
|
22
|
+
confluence getContent --id 123456
|
|
23
|
+
confluence findContent --space DEV --title "API Guide"
|
|
24
|
+
confluence getPageChildren --id 123456 --type page
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 发布与下载
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
confluence uploadMarkdown --file docs/page.md --space DEV --toc --confirm false
|
|
31
|
+
confluence uploadMarkdown --file docs/page.md --id 123456 --attachments '["docs/a.png"]' --toc --confirm true
|
|
32
|
+
confluence uploadHtml --file docs/page.html --space DEV --toc --confirm true
|
|
33
|
+
confluence downloadPage --id 123456 --outputDir exports --downloadAttachments true --downloadChildren true
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## REST 透传
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
confluence listRestApis --group content --limit 20
|
|
40
|
+
confluence callRestApi --method GET --path '/content/{id}' --pathParams '{"id":"123456"}' --query '{"expand":"body.storage,version"}'
|
|
41
|
+
```
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# 内容操作
|
|
2
|
+
|
|
3
|
+
## 查询页面
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
confluence searchContent --cql 'type = page AND title ~ "Runbook"'
|
|
7
|
+
confluence findContent --space DEV --title "Runbook"
|
|
8
|
+
confluence getContent --id 123456
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## 子页、评论、标签
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
confluence getPageChildren --id 123456 --type page
|
|
15
|
+
confluence getComments --id 123456
|
|
16
|
+
confluence addComment --id 123456 --text "LGTM" --confirm true
|
|
17
|
+
confluence getLabels --id 123456
|
|
18
|
+
confluence addLabels --id 123456 --labels '["api","docs"]' --confirm true
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## 安全原则
|
|
22
|
+
|
|
23
|
+
所有删除、评论、标签等写命令都必须显式 `--confirm true`;不传确认时只返回 preview。
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# 总览
|
|
2
|
+
|
|
3
|
+
## 这个 skill 做什么
|
|
4
|
+
|
|
5
|
+
- 用命令行方式操作 Confluence Server/Data Center REST API。
|
|
6
|
+
- 默认写操作只 preview,真实写入必须显式 `--confirm true`。
|
|
7
|
+
- 支持页面搜索、读取、评论、标签、附件、Markdown/HTML 发布、页面下载和 REST 端点透传。
|
|
8
|
+
|
|
9
|
+
## 推荐工作流
|
|
10
|
+
|
|
11
|
+
1. 先确认本机是否安装 `confluence`。
|
|
12
|
+
2. 如果没有,优先运行 `confluence install --skip-config-check true`。
|
|
13
|
+
3. 对命令参数不确定时,先运行 `confluence help <command>` 校对。
|
|
14
|
+
4. 查询类任务优先用 `searchContent`、`getContent`、`findContent`。
|
|
15
|
+
5. 发布类任务优先 dry-run,再加 `--confirm true`。
|
|
16
|
+
6. Markdown/HTML 全量发布默认加 `--toc`,除非用户明确不要目录。
|
|
17
|
+
7. 自动化环境可设置 `CONFLUENCE_DISABLE_WRITE=true` 彻底禁用真实写入。
|
|
18
|
+
|
|
19
|
+
## 适合谁
|
|
20
|
+
|
|
21
|
+
- 需要命令行操作 Confluence 的人。
|
|
22
|
+
- 需要把 Confluence 接入智能体的人。
|
|
23
|
+
- 需要在 Confluence 7.13.7 环境下稳定自动化的人。
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# REST 透传
|
|
2
|
+
|
|
3
|
+
`listRestApis` 和 `callRestApi` 用于覆盖 Confluence 7.13.7 官方 REST 端点。
|
|
4
|
+
|
|
5
|
+
## 查看端点
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
confluence listRestApis --limit 20
|
|
9
|
+
confluence listRestApis --group content --limit 20
|
|
10
|
+
confluence listRestApis --method GET --write false --limit 20
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## 调用端点
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
confluence callRestApi --method GET --path '/content/{id}' --pathParams '{"id":"123456"}' --query '{"expand":"body.storage,version"}'
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
写 REST 端点仍受 `--confirm true` 和 `CONFLUENCE_DISABLE_WRITE=true` 保护。
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# 发布与下载
|
|
2
|
+
|
|
3
|
+
## Markdown 发布
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
confluence uploadMarkdown --file docs/page.md --space DEV --toc --confirm false
|
|
7
|
+
confluence uploadMarkdown --file docs/page.md --id 123456 --toc --confirm true
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
## HTML 发布
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
confluence uploadHtml --file docs/page.html --space DEV --toc --confirm false
|
|
14
|
+
confluence uploadHtml --file docs/page.html --id 123456 --toc --confirm true
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Mermaid 与附件
|
|
18
|
+
|
|
19
|
+
- 默认将 Markdown/HTML 中的 Mermaid 渲染为 PNG 附件并插入图片宏。
|
|
20
|
+
- 如需保留原代码块,使用 `--mermaid none`。
|
|
21
|
+
- 附件用 JSON 数组传入:`--attachments '["docs/a.png"]'`。
|
|
22
|
+
|
|
23
|
+
## 下载
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
confluence downloadPage --id 123456 --outputDir exports --downloadAttachments true --downloadChildren true
|
|
27
|
+
```
|