Sitecore Command Line Interfaceをインストールする

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

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

Sitecore Command Line Interface(CLI) は、ターミナルにインストールするツールです。

注記

既存のCLIインストールをアップグレードするには、「 Upgrade Sitecore Command Line Interface」を参照してください。

Sitecore CLIは、個別プロジェクト用のローカルツールとして、またはすべてのプロジェクトにグローバルツールとしてインストールできます。

大事な

Sitecore CLIをグローバルツールとしてインストールすることは推奨しません。異なるSitecoreインスタンスは異なるバージョンのSitecore CLIを必要とする場合があります。

Sitecore CLIをインストールする前に、ワークステーションに .NET 8をインストールしている必要があります。必要な.NET Coreのバージョンをインストールしていない場合、以下のメッセージが表示されます。

Package sitecore.cli {version} is not compatible with netcoreapp3.1 (.NETCoreApp,Version=v3.1) / any. 
Package sitecore.cli {version} supports: net8.0 (.NETCoreApp,Version=v8.0) / any

Sitecore CLIをローカルプロジェクトツールとしてインストールするには:

管理者権限を持つ端末をOpenします。

Sitecore CLIをインストールするには以下のコマンドを実行してください:

cd <project folder>
dotnet new tool-manifest
dotnet nuget add source -n Sitecore https://nuget.sitecore.com/resources/v3/index.json
dotnet tool install Sitecore.CLI

注記

同じプロジェクトに取り組む他の開発者は、dotnet tool restoreを実行するだけでインストールSitecore CLIできます。

CLIを全体にインストールするには、installコマンドを実行するときに-gオプションを使用してください(推奨されません)。

インストールが完了すると、以下のメッセージが表示されます:

You can invoke the tool from this directory using the following commands: 'dotnet tool run sitecore' or 'dotnet sitecore'.
Tool 'sitecore.cli' {version} was successfully installed. Entry is added to the manifest file {project-path}.config\dotnet-tools.json.

注記

以下の手順の例は簡易化のために例版を使用していますが、CLIをインストールするとターミナルに表示されるバージョンはlatest official release availableです。

新しいプロジェクトを初期化するには、プロジェクトフォルダ内の以下のコマンドを実行してください:
dotnet sitecore init
注記

コマンドdotnet sitecore init CLIと同じバージョンのデフォルトプラグインをsitecore.jsonファイルに追加します。プラグインはSitecore.DevEx.Extensibility.Serialization、Sitecore.DevEx.Extensibility.Publishing、Sitecore.DevEx.Extensibility.Indexing、Sitecore.DevEx.Extensibility.ResourcePackage、Sitecore.DevEx.Extensibility.Databaseです。次のSitecore CLIコマンドでは、CLIがプラグインの解析とインストールを試みます。
XM Cloudプラグインをインストールしたい場合は、以下のコマンドを実行してください:
dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.XMCloud
注記

XM Cloudプラグインとその提供されるコマンドは、SitecoreAIインスタンスを必要とします。

XM Cloudは現在SitecoreAIとなっています

一部のコード例、画像、UIラベルは、エンジニアリング資産の更新中もXM Cloudを使用している場合があります。

プロジェクトの初期化を以下のコマンドで確認してください:

dotnet sitecore plugin list

もしこれがdotnet sitecore initの後の最初のコマンドであれば、CLIはsitecore.jsonファイルに記載されたプラグインの解決とインストールを試みます。コマンドはインストールされているプラグインを知らせるメッセージを出力します。例えば：

>> Begin installing NuGet packages: Sitecore.DevEx.Extensibility.Serialization@{version}, Sitecore.DevEx.Extensibility.Publishing@{version}, Sitecore.DevEx.Extensibility.Indexing@{version}, Sitecore.DevEx.Extensibility.ResourcePackage@{version}, Sitecore.DevEx.Extensibility.Database@{version}

インストールが成功した場合、コマンドはインストール済みプラグインとそのバージョン情報を一覧表示します:

List of plugins:
[Installed] Sitecore.DevEx.Extensibility.Serialization v.{version}
[Installed] Sitecore.DevEx.Extensibility.Publishing v.{version}
[Installed] Sitecore.DevEx.Extensibility.Indexing v.{version}
[Installed] Sitecore.DevEx.Extensibility.ResourcePackage v.{version}
[Installed] Sitecore.DevEx.Extensibility.Database v.{version}

プラグインのインストールが失敗した場合、出力はそのプラグインのFailed状態を表示します。

Sitecore CLIが動作するか確認するには、ターミナルのプロジェクトフォルダに行き、dotnet sitecore -hと入力してください。

Sitecore CLIが準備できていれば、使用方法、オプション、利用可能なトップレベルコマンドを説明するメッセージが表示されます。例えば：

sitecore.cli
  Sitecore command line tool

Usage:
  sitecore.cli [options] [command]

Options:
  --version       Show version information
  -?, -h, --help  Show help and usage information

Commands:
  login               Authenticates the CLI to a Sitecore instance
  plugin              Manage plugins commands
  init                Creates Sitecore configurations in current directory
  connect             Connect to the existing environment
  ser, serialization  Item serialization commands
  publish             Performs a publish operation on all content
  index               working with indexes data
  itemres             Resource Items Package commands
  dbcleanup           Performs cleanup operations for Sitecore databases

この記事を改善するための提案がある場合は、お知らせください!