confluence-cli

confluence-cli — ターミナルから Confluence Wiki を操作

REST API を通じて Atlassian Confluence Cloud を操作します。スペースの一覧表示、ページの閲覧、本文を含むページ内容の表示、CQL による検索、ページの作成ができます。

セットアップ

1. id.atlassian.com/manage/api-tokens で API トークンを生成します
2. 環境変数を設定します。

export CONFLUENCE_EMAIL="[email protected]"
export CONFLUENCE_API_TOKEN="your-api-token"
export CONFLUENCE_SERVER="https://your-domain.atlassian.net"

--help と --dry-run は認証情報なしで動作します。

基本的なコマンド

me — 現在のユーザープロフィール

confluence-cli me                       # your account info
confluence-cli me --json                # machine-readable

spaces — スペースの一覧表示

confluence-cli spaces                   # all accessible spaces
confluence-cli spaces --limit 50        # more results
confluence-cli spaces --json            # machine-readable

pages — ページの一覧表示

confluence-cli pages                                # recent pages across all spaces
confluence-cli pages --space DEV                    # pages in a specific space
confluence-cli pages --space DEV --limit 10          # top 10
confluence-cli pages --space DEV --json             # machine-readable

スペースキーで絞り込みます。キーは内部 ID に自動的に解決されます。

view — ID でページを表示

confluence-cli view 123456                   # full page with body
confluence-cli view 123456 --json            # machine-readable

タイトル、ステータス、バージョン、作成者、タイムスタンプ、HTML 本文（表示用にプレーンテキストに変換）を表示します。--json 出力では、最大 5000 文字までの HTML 本文全体を確認できます。

search — CQL で検索

confluence-cli search --cql 'text~"deploy"'              # full-text search
confluence-cli search --cql 'space=DEV AND type=page'    # by space and type
confluence-cli search --cql 'creator=currentuser()'      # my content
confluence-cli search --cql 'text~"api"' --limit 5       # top 5 results

CQL（Confluence Query Language）は、Confluence の検索構文です。よく使われるパターンは次のとおりです。

• text~"keyword" — 全文検索
• space=KEY — スペースで絞り込み
• type=page — コンテンツタイプで絞り込み
• creator=currentuser() — 自分のコンテンツ
• label="name" — ラベルで検索
• AND で組み合わせます：space=DEV AND text~"deploy"

create — ページを作成

confluence-cli create --space DEV --title "My Page"                             # basic
confluence-cli create --space DEV --title "API Docs" --body "<p>Content</p>"    # with HTML body
confluence-cli create --space DEV --title "Test" --parent 123456                # as child page
confluence-cli create --space DEV --title "Test" --dry-run                      # preview

Confluence Cloud（v2 API）でページを作成します。本文は Confluence のストレージ形式を使用した HTML です。シンプルなページでは、基本的な HTML タグ（<p>、<ul>、<h2> など）を使用できます。

グローバルフラグ

すべてのフラグは、どの位置でも使用できます。

confluence-cli --json pages --space DEV              # flag before subcommand
confluence-cli pages --space DEV --json              # flag after subcommand
confluence-cli --dry-run create --space DEV --title "Test"
confluence-cli --quiet pages                         # suppress non-essential output

既知の注意点

• 認証には、メールアドレスと API トークンを使用する HTTP Basic Auth を使用します。Jira と同じ認証情報ですが、環境変数名は異なります。
• 2 種類の API バージョン — CLI はほとんどの操作（スペース、ページ、作成）で v2 API を使用し、me と search（CQL）では従来の REST API を使用します。ユーザーが意識する必要はありません。
• スペースキーは ID に解決する必要があります — v2 API で絞り込みに使用するには、数値のスペース ID が必要です。CLI はキーを自動的に解決します。そのため、pages --space と create --space では API 呼び出しが 1 回追加されます。
• ページ本文は HTML です — Confluence のストレージ形式は HTML を使用します。CLI は表示時に HTML タグを除去し、--json 出力では最大 5000 文字までの生の HTML を返します。リッチな書式のページを作成するには、有効な HTML が必要です。
• CQL 検索の注意点 — CQL のほとんどの演算子では、大文字と小文字が区別されません。text~ 演算子は本文全体を検索します。複数語のフレーズは、エスケープした引用符で囲んでください。
• レート制限 — Confluence Cloud にはレート制限があります。CLI は自動的に再試行しません。

参考資料

• scripts/confluence-cli — CLI バイナリです。cli-builder のパターンに従って構築されています。非対話型、--json、--dry-run、--quiet、--verbose、emit() による二重出力、遅延認証、構造化ログに対応しています。
• Confluence REST API v2 docs — 公式 API リファレンスです。
• CQL (Confluence Query Language) — 検索構文のリファレンスです。
• API Token Management — トークンの生成と取り消しを行います。