コマンドラインツール

CLIツールを使用すると、Liferay Cloudサービスを表示および管理できます。 インストールが完了したら、ターミナルで lcp --help を実行して、利用可能なアクションを確認できます。

• CLIツールのインストール
• CLIツールをバージョン2からバージョン3にアップグレードする
• CLIリモートの設定
• サービスログの表示
• サービスインスタンス数の変更
• プロジェクトまたはサービスの一覧
• サービスの再起動
• Liferayクラウド環境へのデプロイ
• Liferayサービスからファイルをダウンロードする
• サービスのシェルへのアクセス
• CLIツールのバージョン3をアンインストールする

CLIツールのインストール

*nixシステム

各リリースには、各インストーラーおよびバイナリのSHA-256チェックサムが含まれています。 以下の手順で新しいコピーをダウンロードし、その整合性を確認してください。

1. スクリプトとそのチェックサムをダウンロードしてください。

   curl -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/install.sh
   curl -fsSLO https://cdn.liferay.cloud/lcp/stable/latest/install.sh.checksum
   

2. ハッシュ値を比較してください。

   Linux:

   [ "$(sha256sum install.sh | awk '{print $1}')" = "$(tr -d '[:space:]' < install.sh.checksum)" ] \
     && echo "OK" || echo "チェックサムが一致しません — 実行しないでください。"
   

   macOS:

   [ "$(shasum -a 256 install.sh | awk '{print $1}')" = "$(tr -d '[:space:]' < install.sh.checksum)" ] \
     && echo "OK" || echo "チェックサムが一致しません — 実行しないでください。"
   

   出力が OKの場合は、次のステップに進みます。 チェックサムの不一致が表示された場合は、ダウンロードしたファイルを削除して再度試してください。

3. インストール。

   bash ./install.sh
   

   権限エラーが発生した場合は、コマンドを再度実行し、 bash を sudo bash に置き換えてみてください。

Windowsシステム

Windows インストーラーの最新バージョンをダウンロードし、ウィザードの手順に従ってください。

CLIツールをバージョン2からバージョン3にアップグレードする

バージョン3をインストールして使用するには、まず現在使用しているバージョンをアンインストールする必要があります。 これにより、同じバイナリ名による競合を防ぎます。

macOSまたはLinuxでバージョン2をアンインストールする

1. ターミナルを開いて、次のコマンドを実行します。 lcp uninstall.

2. アンインストールが完了したことを確認するには、コマンド lcp を実行します。

Windows版バージョン2のアンインストール

1. Windows 10 では、 コントロール パネル → プログラム → プログラムのアンインストール に移動します。

   または、Windows 7 および 8 の場合は、 コントロール パネル → プログラムの追加と削除 に移動します。

2. lcp amd64-installer-0.3 を選択してください

3. アンインストール をクリックしてから確認してください。

4. アンインストールが完了したことを確認するには、コマンド lcp または lcp.exe を実行します。

CLIバージョン3をインストールする前に、CLIバージョン2がアンインストールされていることを確認してください。

バージョン3のインストール

バージョン 2 をアンインストールしたら、上記の手順に従ってCLI ツールのバージョン 3 をインストールできます。

CLIリモートの設定

CLI ツールを介して Liferay Cloud サービスにアクセスするには、Liferay Cloud のリモート URL を指すように構成する必要があります: liferay.cloud。

CLIのリモートを一覧表示するには、次のコマンドを実行します。

lcpリモート

以下のコマンドを使用して、CLIツールに新しいリモートを追加できます。

lcp リモートセット <remote-alias> <remote-url>

必要に応じて、デフォルトのリモートを変更できます：

lcp リモートデフォルト <remote-alias>

または、リモートインラインを指定することもできます：

lcp shell -p <project-id> --service <service-id> --remote <remote-alias>

バックアップのダウンロード

ID を使用して特定のバックアップをダウンロードするには、 lcp backup コマンドを使用します。

データベースとドキュメントライブラリを同時にダウンロードするには、以下のコマンドを実行してください。

lcp backup download --backupId <ID>

または、 --database または --doclib フラグを追加して、指定したものだけをダウンロードします。

lcp バックアップ ダウンロード <type> --backupId <ID>

サービスログの表示

lcp log コマンドを使用して、特定のプロジェクト、サービス、およびインスタンスのログを表示します。 以下に一般的なコマンドを示しますが、 lcp log --help を実行すると、使用可能なコマンドオプションを確認できます。

プロジェクト環境のすべてのサービスログを表示する：

lcp log -p <project>-<environment>

プロジェクト環境内の単一サービスのログを表示する：

lcp log -p <project>-<environment> -s <service>

または、サービスの完全なURLを使用してログを表示することもできます。

lcp log --url <service>-<project>-<environment>.lfr.cloud

デフォルトでは、 lcp log コマンドは、ネットワークへの影響を軽減するために 10,000 行のみを返します。 ただし、 --since および --until パラメータを使用して期間を指定することで、この制限を回避できます (例: 昨日、 "昨日午後 9 時"、 "10 分12日前"、 "mm/dd/YYYY HH:mm:ss")。

特定の時点から現在までのプロジェクト環境におけるすべてのサービスログを表示します。

lcp log -p <project>-<environment> --since <start_time>

特定の期間におけるプロジェクト環境のすべてのサービスログを表示する：

lcp log --since "<start_time>" --until "<end_time>"

lcp log コマンドの出力をファイルにパイプするには、コマンドの末尾に >> "<new-file.txt>" を追加します。 実行すると、新しいファイルはターミナルの現在のパスに作成されます。

lcp log -p <project>-<environment> -s <service> --since "<start_time>" --until "<end_time>" >> "<new-file.txt>"

サービスインスタンス数の変更

環境サービスを個別にスケールするには、 lcp scale コマンドを使用します。 これらの例には一般的なコマンドが含まれていますが、 lcp scale --help を実行すると、使用可能なコマンドオプションを確認できます。

プロジェクト環境におけるすべてのサービスとそのインスタンスを表示し、スケーリングするサービスを選択します。

lcp scale -p <project>-<environment>

次に、ターミナルの指示に従ってサービスを選択し、そのインスタンス数を決定します。

または、 lcp scale コマンドの一部として、対象サービスと必要なインスタンス数を指定します。

lcp scale -p <project>-<environment> -s <service> <instances>

インスタンスの完全なURLを使用してスケールすることもできます。

lcp scale --url <service>-<project>-<environment>.lfr.cloud <instances>

プロジェクトまたはサービスの一覧

lcp list コマンドを使用して、プロジェクト サービスとそのイメージおよびステータスを表示します。 これらの例には一般的なコマンドが含まれていますが、 lcp list --help を実行すると、使用可能なコマンドオプションを確認できます。

自分が所有または共同で取り組んでいるプロジェクト、サービス、インスタンスの完全なリストを表示します。

lcpリスト

環境固有のサービスの画像とステータスを表示します。

lcp list -p <project>-<environment>

特定のサービスの画像とステータスを確認する：

lcp list -p <project>-<environment> --service <serviceID>

または、サービスの完全な URL を lcp list に渡すことでサービスをチェックすることもできます。

lcp list --url <service>-<project>-<environment>.lfr.cloud

サービスの再起動

環境サービスを再起動するには、 lcp restart コマンドを使用します。 これらの例には一般的なコマンドが含まれていますが、 lcp restart --help を実行すると、使用可能なコマンドオプションを確認できます。

プロジェクトのすべての環境とサービスを表示し、再起動する環境サービスを選択します。

lcp restart

プロジェクト内の特定のサービスを再起動する：

lcp restart -p <project>-<environment> -s <service>

または、完全な URL を lcp restart に渡してサービスを再起動することもできます。

lcp restart --url <serviceID>-<projectID>.lfr.cloud

Liferayクラウド環境へのデプロイ

lcp deploy コマンドを使用して、特定のサービスまたはすべてのサービスをいずれかの環境にデプロイします。

lcp deploy

リポジトリのルート ディレクトリから lcp deploy を実行すると、選択した環境に該当するすべてのサービスがデプロイされます。 サービスを環境にデプロイするには、サービスのフォルダー (そのフォルダーにサービスの LCP.json ファイルがある) からコマンドを実行します。

デフォルト以外のリモート（IDで指定）を指定するには、コマンドを -r の形式で実行します。

lcp deploy -r <remote-id>

詳細については、 CLIツールによる変更のデプロイ を参照してください。

Liferayサービスからファイルをダウンロードする

Liferay サービスからファイルをダウンロードするには、 files download コマンドを使用します。 ファイルは、Liferay サービスの永続ストレージディレクトリ (/mnt/persistent-storage/ ) 内に配置する必要があります。

例えば、

lcp ファイルのダウンロード --prefix パス/to/ファイル --dest 宛先

このコマンドは、Liferay サービスの /mnt/persistent-storage/path/to/files/ ディレクトリからすべてのファイルを destination/ フォルダにダウンロードします。

--concurrency フラグを使用して、並列ダウンロードするファイルの数を変更します（デフォルトは 100）。

例えば、以下のコマンドは、 /mnt/persistent-storage/path/to/files/ ディレクトリからすべてのファイルを現在の作業ディレクトリにダウンロードします。一度に最大 600 ファイルまでダウンロードできます。

lcp files download --prefix path/to/files --concurrency 600

lcp files download --help を実行して、利用可能なすべてのコマンドオプションを確認してください。

サービスのシェルへのアクセス

サービスコンテナのシェルにアクセスするには、次のコマンドを実行します。

lcpシェル

これにより、コンテナ内のすべてのサービスが一覧表示され、 からアクセスするサービスを選択するよう求められます。

または、 サービスのプロジェクト ID とサービス ID を lcp shell コマンドに追加することで、特定のサービスのコンテナのシェルにアクセスできます。

lcp shell -p <project>-<environment> -s <service>

ドキュメントを開く

lcp docs コマンドを使用して、公式ドキュメント、ヘルプセンターのコンテンツなど、Liferay Cloud のリソースにアクセスします。

CLIツールのバージョン3をアンインストールする

MacとLinuxの場合は、以下のコマンドを実行してください。

curl https://cdn.liferay.cloud/lcp/stable/latest/uninstall.sh -fsSL | bash

Windows 7 および 8 の場合は、 コントロール パネル → プログラムの追加と削除 に移動します。 Windows 10 では、 コントロール パネル → プログラム → プログラムのアンインストール に移動します。 次に、プログラムの一覧から LCP CLI を見つけて選択し、 アンインストール をクリックします。 ウィザードの手順に従ってください。

関連トピック

• トラブルシューティングツールとリソース
• CLIツールによる変更点のデプロイ