Getting Started#

このページでは、confluence-cliのインストール方法と基本的な使い方を説明します。

Requirements#

  • Python 3.10以上

Install#

$ pip install kci-confluence-cli

Usage#

認証情報の指定#

Confluenceにアクセスするための認証情報は、以下のいずれかの方法で指定できます。

環境変数で指定#

export CONFLUENCE_USER_NAME="your_username"
export CONFLUENCE_USER_PASSWORD="your_password"

コマンドライン引数で指定#

$ confluence --confluence_user_name your_username --confluence_user_password your_password [command]

標準入力から指定#

上記の方法で認証情報が指定されない場合は、コマンド実行時に標準入力から認証情報を入力できます。

ConfluenceのURLの指定#

アクセスするConfluenceのURLは、以下のいずれかの方法で指定できます。

環境変数で指定#

export CONFLUENCE_BASE_URL="https://your-domain.com/confluence"

コマンドライン引数で指定#

$ confluence --confluence_base_url https://your-domain.com/confluence [command]

標準入力から指定#

上記の方法で指定されない場合は、コマンド実行時に標準入力からURLを入力できます。

content_id の調べ方#