atlassian-cli の一部

Confluence CLI

ページ、スペース、エクスポートをターミナルから管理。CQL 検索、一括バックアップ、Markdown 同期、添付ファイルの操作に対応します。

atlassian-cli はコミュニティによる独立したオープンソースプロジェクトです。Atlassian と提携・関連しておらず、Atlassian による承認、推奨、後援のいずれも受けておらず、Atlassian が提供する公式 CLI(acli)でもありません。製品名は互換性を示す目的でのみ使用しています。

Confluence CLI とは

Confluence CLI(atlassian-cli confluence)は、Atlassian Confluence Cloud 向けのコマンドラインツールです。ページとスペースのライフサイクル全体をカバーし、CQL による検索、ページの作成・更新・削除、添付ファイルの管理、バックアップ用のスペースのエクスポート、ページの一括ラベル付けや一括削除、Markdown リポジトリの Confluence への同期に対応します。出力形式(JSON、CSV、YAML、テーブル)を選べるため、監査やダッシュボード、その他の自動化に結果をそのまま渡せます。

atlassian-cli の一部として提供されます。これは JiraBitbucketJira Service Management にも対応する、オープンソースの単一 Rust バイナリです。Homebrew または Cargo でインストールし、Atlassian Cloud の API トークンで認証します。

Confluence CLI が役立つ場面

Confluence の機能

Confluence をコマンドラインから管理するために必要な機能をひととおり用意しています

スペースとページの管理

ページとスペースの作成、更新、削除ができます。ラベル、コメント、権限もターミナルから管理できます。

CQL 検索

CQL をフルサポートし、ページとブログ記事を検索できます。スペース、タイプ、ラベル、貢献者、最終更新日で絞り込めます。

一括エクスポートとバックアップ

ページ、ブログ記事、添付ファイルを含むスペース全体をエクスポートできます。マニフェスト情報付きで、タイムスタンプを含むバックアップを作成します。

添付ファイルの操作

添付ファイルの一覧表示、アップロード、ダウンロード、削除ができます。ページやスペースのバックアップから添付ファイルを一括ダウンロードできます。

ブログ記事の管理

ブログ記事の作成、更新、エクスポートができます。自動化されたドキュメントパイプラインで、ページと合わせてブログのコンテンツを管理できます。

ページ分析

ページビュー数、貢献者の履歴、バージョン情報を取得できます。コンテンツの鮮度と閲覧状況を追跡します。

実際のコマンド

本番のランブックで使われている CLI コマンド

添付ファイルを含むスペースのバックアップ

# Export all pages from a space
atlassian-cli confluence bulk export \
  --profile prod \
  --cql "space = DOCS AND type = page" \
  --output pages.json \
  --format json

# Get space metadata
atlassian-cli confluence space get \
  --profile prod \
  DOCS \
  --format json

# List and download attachments
atlassian-cli confluence attachment list \
  --profile prod \
  123456 \
  --format json

Markdown を Confluence に同期

# Search for existing page by title
atlassian-cli confluence search cql \
  --format json \
  "space = DOCS AND title = \"API Reference\""

# Create a new page in a space
atlassian-cli confluence page create \
  --profile prod \
  --space DOCS \
  --title "API Reference"

# Update page content from file
atlassian-cli confluence page update \
  --profile prod \
  123456 \
  --title "API Reference" \
  --body content.html

# Add labels for organization
atlassian-cli confluence page add-label \
  --profile prod \
  123456 \
  "auto-generated" "documentation"

クイックスタート

1 分もかからずにインストールし、Confluence の管理を始められます

1. インストール

# Homebrew (macOS & Linux)
brew install omar16100/atlassian-cli/atlassian-cli

# Or via Cargo
cargo install atlassian-cli

2. 認証

# Add your Confluence instance
atlassian-cli auth login \
  --profile work \
  --base-url https://your-domain.atlassian.net \
  --email you@company.com

# Verify connection
atlassian-cli auth test --profile work

3. 使ってみる

# Search your Confluence space
atlassian-cli confluence search cql \
  --profile work \
  "space = DOCS AND type = page"

Confluence のコマンドグループ

各グループからコマンドリファレンス全文にリンクしています。

グループ 対応範囲
confluence search cql / text / in-space CQL クエリ、全文検索、スペース単位の検索。タイプ、ラベル、貢献者、更新日で絞り込み。
confluence space スペースの作成、更新、削除、一覧表示。スペースの権限管理。
confluence page ページの CRUD、バージョン履歴、ラベル、コメント、閲覧制限。アクセス権のあるすべてのページで利用可能。
confluence blog 任意のスペースでのブログ記事の CRUD。
confluence attachment ページの添付ファイルのアップロード、ダウンロード、一覧表示、削除。
confluence bulk export / delete / add-labels CQL フィルターとドライランに対応した一括操作。スペース全体を JSON にエクスポート、古いコンテンツを整理、大規模なラベルの付け直し。
confluence analytics レポート用のページビューとスペース統計の分析。

フラグと出力スキーマについてはコマンドリファレンス全文をご覧ください。認証の設定は認証ガイドで説明しています。

Confluence のよくある操作

コピーして貼り付けるだけで使える出発点です。フラグとスキーマの全体はコマンドリファレンスにあります。

はじめて使う方は、Confluence CLI ガイドで作成、検索、エクスポート、一括処理のワークフローを最初から最後まで確認できます。

よくある質問

Confluence のスペースをバックアップするには?

atlassian-cli confluence bulk export --cql "space = DEV" --format json --output backup.json を実行します。スペース内の全ページが 1 つの JSON ファイルにまとまり、S3 や Git など任意の場所に保存できます。対応する添付ファイルは attachment グループで取得します。最初から最後までのスクリプトは Confluence バックアップランブックにあります。

Markdown ファイルを Confluence に同期できますか?

はい。一般的な方法は、pandoc で Markdown を Confluence のストレージ形式に変換し、その HTML を confluence page create または confluence page update に渡す流れです。Markdown → Confluence ランブックには、ページタイトルをキーにした冪等なアップサートを行う本番向けスクリプトがあります。

CQL とは何で、どう使いますか?

Confluence Query Language のことです。Jira の JQL と同じ形式ですが、Confluence 固有のフィールドを使います。space = DEVtype = pagelabel = onboardinglastmodified >= "2026-01-01" などです。句は AND / OR で組み合わせます。CLI は CQL をそのまま受け付けるので、atlassian-cli confluence search cql "space = DEV AND type = page AND label = onboarding" のように実行できます。

一括操作にドライランモードはありますか?

はい。confluence bulk のすべてのサブコマンドは --dry-run を受け付けます。変更系の API を呼び出さずに、影響を受けるはずのページの正確な一覧を出力します。まずこれを実行して一覧を確認し、その後フラグを外して実行し直してください。

Confluence Data Center でも動作しますか?

主な対象は Confluence Cloud です。Data Center のインスタンスでも互換性のある v2 REST API を公開している場合がありますが、対応状況はさまざまです。現時点の DC の対応状況は GitHub リポジトリをご確認ください。

無料ですか?

はい。MIT ライセンスのオープンソースです。Confluence のインスタンス自体には Atlassian Cloud のサブスクリプションが必要ですが、CLI はどのような用途でも無料です。

Confluence CLI のよくある質問

Confluence をコマンドラインから管理する

Confluence をコマンドラインから管理するには?

atlassian-cli は、ページ、スペース、フォルダー、ブログ記事、CQL 検索、一括エクスポート、添付ファイルに対応した Confluence CLI です。認証を済ませたら、atlassian-cli confluence page list --space DEVatlassian-cli confluence search cql "space = DEV" のようなコマンドを実行します。詳しくは Confluence コマンドリファレンスをご覧ください。

Confluence CLI は v2 Folder API と Markdown に対応していますか?

はい。バージョン 0.4 で、Confluence v2 Folder API に対応する confluence folder コマンドグループと、Markdown から ADF への変換が追加されました。0.4 の新機能または変更履歴をご覧ください。

これは Atlassian 公式の Confluence CLI ですか?

いいえ。atlassian-cli は独立したオープンソースツールであり、Atlassian と提携・関連しておらず、Atlassian による承認、推奨、後援、保守のいずれも受けていません。Atlassian は別途、独自の公式 CLI(acli)を提供しています。

Confluence CLI は無料ですか?

はい。atlassian-cli は MIT ライセンスの無料のオープンソースソフトウェアです。インストールページまたは GitHub から入手できます。

コピーしました