lc-semba-ryuichiro Confluence 情報取得ガイド
目次
概要
atl-fetchはAtlassian CloudからConfluenceページ情報を取得するCLIツール。ページ本文、バージョン履歴、添付ファイルを一括で取得できる。
事前準備チェックリスト
取得する前に確認する。
- 環境変数
ATLASSIAN_EMAILが設定されているか - 環境変数
ATLASSIAN_API_TOKENが設定されているか - 対象のConfluenceスペースへのアクセス権があるか
- Node.jsがインストールされているか
実行方法
atl-fetchはnpxで都度実行する。グローバルインストールは不要。
npx atl-fetch [Confluence URL] [オプション]
CLI オプション一覧
| オプション | 説明 | デフォルト |
|---|---|---|
-f, --format |
出力形式 (json/markdown/yaml) | json |
-d, --download |
添付ファイルをダウンロード | false |
-o, --dir <path> |
ダウンロード先ディレクトリ（--download 必須） |
- |
--diff |
差分のみ表示 | false |
--color |
カラー出力有効 | true |
--no-color |
カラー出力無効 | false |
-v, --verbose |
詳細出力を有効化 | false |
--debug |
デバッグ出力を有効化（開発者向け） | false |
認証情報の確認
認証情報が正しく設定されているか確認する。
npx atl-fetch auth check
URL フォーマット
ConfluenceページURLは以下の形式で指定する。
https://{org}.atlassian.net/wiki/spaces/{SPACE}/pages/{ID}/{TITLE}
例:
https://mycompany.atlassian.net/wiki/spaces/DEV/pages/12345678/Getting+Startedhttps://example.atlassian.net/wiki/spaces/DOCS/pages/98765432/API+Reference
よくある使用パターン
ページ情報を JSON で取得
npx atl-fetch https://mycompany.atlassian.net/wiki/spaces/DEV/pages/12345678/Guide
Markdown 形式で取得
npx atl-fetch https://mycompany.atlassian.net/wiki/spaces/DEV/pages/12345678/Guide -f markdown
添付ファイルをダウンロード
npx atl-fetch https://mycompany.atlassian.net/wiki/spaces/DEV/pages/12345678/Guide -d -o ./downloads
差分のみ表示
npx atl-fetch https://mycompany.atlassian.net/wiki/spaces/DEV/pages/12345678/Guide --diff
出力内容
Confluenceページから以下の情報を取得する。
| フィールド | 説明 |
|---|---|
| id | ページ ID |
| title | ページタイトル |
| spaceKey | スペースキー |
| body | ページ本文 |
| currentVersion | 現在のバージョン |
| versions[] | バージョン履歴 |
| attachments[] | 添付ファイル一覧 |
出力形式
JSON 形式（デフォルト）
{
"id": "12345678",
"title": "ページタイトル",
"spaceKey": "DEV",
"body": "ページ本文...",
"currentVersion": 5,
"versions": [],
"attachments": []
}
Markdown 形式
# ページタイトル
**スペース**: DEV
**バージョン**: 5
## 本文
ページ本文...
## バージョン履歴
- v5 [2024-01-10] - 更新者名
- v4 [2024-01-05] - 更新者名
トラブルシューティング
認証エラーが発生する
環境変数を確認する。
echo $ATLASSIAN_EMAIL
echo $ATLASSIAN_API_TOKEN
権限エラーが発生する
対象スペースへのアクセス権を確認する。
URL が認識されない
URLフォーマットが正しいか確認する。/wiki/spaces/ が含まれているか確認。
追加リソース
リファレンスファイル
詳細なオプション説明については以下を参照。
references/confluence-options.md... オプションの詳細説明、環境変数設定ガイド