1. 開始方法

開始方法

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

このトピックでは、サポート対象のプラットフォームに Sitecore Content Hub ™ のコマンドライン インターフェイス (CLI) をインストールして設定する方法について説明します。

インストール

最初の手順

[!注] インストール方法やオペレーティング システムによっては、次の各例にある ch-cli を次のいずれかに置き換える必要があります。

  • Windows: ch-cli.exe
  • macOS または Linux: ./ch-cli
  • Docker: docker run --rm -it -v ch-cli-data:/root/.ch-cli scr.sitecore.com/sch/ch-cli

ヘルプ

すべてのレベルで --help オプションを使用でき、利用可能なコマンドやオプションの確認で効果的です。

例

使用可能なコマンドとオプションの概要をルート レベルで表示できます。

ch-cli --help

ヘルプ出力を login コマンドに関する内容に絞り込みます。

ch-cli endpoint --help

ログイン

Sitecore Content Hub のインスタンスを操作するには、まずログインする必要があります。

ログイン コマンドを実行すると、指定した Sitecore Content Hub のインスタンスにリダイレクトされ、ログインすると、クライアントへのアクセス許可を付与できます。 使用可能なコマンドは次のとおりです。

ch-cli endpoint add --name <name> --url https://your.content.hub.url/ --client-id <OAuth client ID> --client-secret <OAuth client secret>

[!重要] OAuth クライアントのリダイレクト URL と、CLI で指定するリダイレクト URL は完全に一致している必要があります。 この URL は、既定では http://localhost:9000/ ですが、--redirect-uri 引数を使用して次のようにオーバーライドできます。 ch-cli endpoint add --name &lt;name&gt; --url https://your.content.hub.url/ --client-id &lt;OAuth client ID&gt; --client-secret &lt;OAuth client secret&gt; --redirect-uri http://localhost:9123/

このコマンドを実行すると、指定した Sitecore Content Hub のインスタンスにリダイレクトされ、クライアントにアクセス許可を付与できます。 付与に同意すると、ログインしてコマンドの実行を開始できます。同意しないとコマンドを実行できません。

各要素の説明

  • name - さまざまなインスタンス (ステージングと本番、まったく異なるプロジェクトや顧客など) への複数の接続を管理できるようにする一意の識別子。
  • url - インスタンスのベース URL。
  • client-id - 認証フローに使用する OAuth クライアントの ID。
  • client-secret - 指定した OAuth クライアントのクライアント シークレット。
  • redirect-uri - 承認を完了するためのリダイレクト URL をオーバーライドできます (任意)。

設定

CLI に関連するすべての設定は、次のように現在のユーザーのディレクトリにある .ch-cli ディレクトリに JSONファイルとして保存されます。

OSパス
Windows%USERPROFILE%\.ch-cli
Linux/macOS$HOME/.ch-cli
Docker&lt;your volume&gt;
この記事を改善するための提案がある場合は、 お知らせください!