CLIオプション

Catalystは、CLIコマンドと一緒に使用できる以下のCLIオプションを提供しています。

-v | --version

このオプションは、現在使用しているCatalyst CLIのバージョン番号を表示します。 -vまたは
--versionをcatalystコマンドと以下のように使用できます。

-p | --project <name_or_project_id> --org <org_id>

-pまたは--projectオプションは、CLIコマンドを実行するCatalystプロジェクトの名前またはIDを指定するために使用します。このオプションは、CLIで作業ディレクトリのプロジェクトを初期化またはアクティブにしていない場合に非常に便利です。また、トークンを使用してアクティブなログインセッションなしで、リモートコードリポジトリやCIシステムなどのリモートシステムからCatalyst CLIコマンドを実行する場合にも、このオプションを使用できます。

プロジェクトの初期化や有効化を行わずに、コマンドの対象となるプロジェクトを直接指定してCatalystコマンドを実行できます。プロジェクトの名前またはIDをオプションとともに指定する必要があります。

たとえば、ShipmentTrackingというプロジェクトでAPI Gatewayを有効にするには、このオプションを使用して以下のCLIコマンドを実行できます。

また、オプションで--orgオプションを使用して、プロジェクトが属し、CLIコマンドを実行するCatalyst組織のIDを指定することもできます。

たとえば、CLIからプロジェクトのWebクライアントをデプロイするには、これら両方のオプションを使用して以下のCLIコマンドを実行します。

--token <token>

--tokenオプションは、Catalyst CLIコマンドの実行を認証するために使用します。Catalyst CLIトークンを使用すると、アクティブなユーザーセッションにログインすることなく、CIツールなどのリモートシステムからCLIコマンドを実行できます。Catalyst CLIトークンの詳細については、トークンの使用のヘルプページをご覧ください。

CLIからユーザーアカウントにログインしている状態でトークンを生成する必要があります。その後、任意のリモートシステムからそのトークンを使用して、アクティブなログインセッションなしですべてのCLI操作を実行できます。これは、CLIコマンドの後にオプションとしてトークンを指定することで行われます。このトークンはそのユーザーアカウントの認証要素として機能し、指定したプロジェクトにコマンドの実行をマッピングし続けます。

たとえば、--tokenオプションを使用して、リモートシステムからCatalystプロジェクトの関数コンポーネントをプロジェクトディレクトリに初期化できます。

これにより、Catalystはトークンを検証し、トークンが有効であれば初期化プロセスを開始します。

--dc<us|eu|in|jp|sa|au|ca>

--dc<us|eu|in|au|ca>オプションを使用すると、特定のDCログインからコマンドを実行できます。Catalystは現在、US、EU、IN、JP、SA、AU、CAの7つのデータセンターで利用可能です。通常、CLIにログインする際にアクセスするデータセンターを選択できます。

Catalystでは、各データセンターから同時に異なるログインを維持できます。つまり、両方のデータセンターにそれぞれ有効なトークンを1つずつ持ち、コマンドの実行を認証できます。その後、このオプションを使用してデータセンターを指定し、いずれかのデータセンターからコマンドを実行することを選択できます。

たとえば、EUとUS DCの両方に有効なログインがある場合、以下のようにコマンドを実行して、USデータセンターに関連付けられたユーザーアカウントのディレクトリにプロジェクトとそのリソースを初期化できます。

これにより、Catalystは指定したデータセンターの資格情報を検証した後、プロジェクトを初期化します。

--verbose

--verboseオプションは、CLIコマンドが実行されるときに行われるアクションに関する詳細情報を表示するために使用します。コマンド実行時にサーバーに送信されるHTTPリクエストの詳細、受信したレスポンスの詳細、CLI環境の詳細、サーバーへの接続に使用される認証トークン、設定されたCookieなどの情報が表示されます。

--verboseオプションは、CLIコマンドの実行をデバッグおよびトラブルシューティングし、エラーの原因を特定するのに役立ちます。任意のCLIコマンドで--verboseオプションを使用できます。

たとえば、verboseオプションを使用してプロジェクト一覧コマンドを実行できます。

-h | --help

-hまたは--helpオプションは、CLIコマンドのヘルプを取得するために使用します。コマンドの機能の簡単な説明と、コマンドで使用可能なオプションとその構文が表示されます。

たとえば、catalyst functions:shellコマンドのヘルプが必要な場合は、以下のコマンドを実行できます。

catalyst help functions:shellを実行してコマンドのヘルプを取得することもできます。