# CLIドキュメント ## v1 -------------------------------------------------------------------------------- title: "CLIコマンドリファレンス" description: "CLIコマンドリファレンスは、ターミナルから実行できるCatalyst CLIで利用可能なすべてのコマンドを一覧表示します。" last_updated: "2026-08-17T13:08:49.603Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/cli-command-reference/" service: "All Services" -------------------------------------------------------------------------------- # CLIコマンドリファレンス Catalystコマンドにアクセスするには、システムにCatalyst CLIがインストールされている必要があります。手順については、Catalyst CLIのインストールのヘルプページを参照してください。 ### オプション <table class="content-table"> <thead> <tr> <th>コマンド構文</th> <th>使用方法</th> </tr> </thead> <tbody> <tr> <td> <strong>-v</strong> | <strong>--version</strong> </td> <td>Catalyst CLIのバージョン番号を表示します</td> </tr> <tr> <td><strong>-p</strong> | <strong>--project &lt;name_or_project_id&gt;</strong></td> <td>コマンドに使用するCatalystプロジェクトを指定します</td> </tr> <tr> <td><strong>--org &lt;org id&gt;</strong></td> <td>コマンドに使用するCatalyst組織を指定します。-pオプションと併用します。</td> </tr> <tr> <td><strong>--token &lt;token&gt;</strong></td> <td>コマンドの認証トークンを指定します</td> </tr> <tr> <td><strong>--dc &lt;us|eu|in|jp|sa|au|ca&gt;</strong></td> <td>コマンドのデータセンターを指定します</td> </tr> <tr> <td><strong>--verbose</strong></td> <td>デバッグ目的でログレベルをverboseに変更します</td> </tr> <tr> <td><strong>-h</strong> | <strong>--help</strong></td> <td>Catalystコマンドのヘルプを表示します</td> </tr> </tbody> </table> <br> ### コマンド <table class="content-table"> <thead> <tr> <th>コマンド構文</th> <th>使用方法</th> </tr> </thead> <tbody> <tr> <td><strong>login [options]</strong></td> <td>CLIをCatalystアカウントにログインします</td> </tr> <tr> <td><strong><strong>token:generate [options]</strong></strong></td> <td>リモートシステムからCLIへのアクセスを認証するためのトークンを生成します</td> </tr> <tr> <td><strong>token:list</strong></td> <td>このCLIで生成されたすべての利用可能なトークンを一覧表示します</td> </tr> <tr> <td><strong>token:revoke &lt;id&gt;</strong></td> <td>このCLIで生成されたトークンを取り消します</td> </tr> <tr> <td><strong><strong>whoami</strong></strong></td> <td>現在ログインしているユーザーのメールアドレスを表示します</td> </tr> <tr> <td><strong>init [feature] [options]</strong></td> <td>ローカルディレクトリでCatalystプロジェクト、関数、AppSail、クライアントリソースを初期化します</td> </tr> <tr> <td><strong><strong>project:list</strong></strong></td> <td>アクセス可能なすべてのCatalystプロジェクトを一覧表示します</td> </tr> <tr> <td><strong>project:use [name_or_project_id] </strong></td> <td>作業ディレクトリにアクティブなCatalystプロジェクトを設定します</td> </tr> <tr> <td><strong>project:reset</strong></td> <td>アクティブなプロジェクトの選択をクリアし、ベースプロジェクトにリセットします</td> </tr> <tr> <td><strong>pull [feature]</strong></td> <td>リモートコンソールからローカルディレクトリにプロジェクトのリソースをプルします</td> </tr> <tr> <td><strong>iac:export [options]</strong></td> <td>プロジェクトのコードと設定をZIPファイルとしてエクスポートします</td> </tr> <tr> <td><strong>iac:import [options][file_path]</strong></td> <td>プロジェクトのZIPファイルをインポートし、コンソールに新しいプロジェクトを作成します</td> </tr> <tr> <td><strong>iac:pack [zip_name]</strong></td> <td>標準形式でプロジェクトのインポート用ZIPファイルを生成します</td> </tr> <tr> <td><strong>iac:status [options]&lt;operation&gt;</strong></td> <td>スケジュールされたインポートまたはエクスポートジョブの現在のステータスを取得します</td> </tr> <tr> <td><strong>functions:setup</strong></td> <td>プロジェクトディレクトリで関数ディレクトリをセットアップおよび設定します</td> </tr> <tr> <td><strong>functions:add</strong></td> <td>必要なスタックの関数を関数ディレクトリに追加します</td> </tr> <tr> <td><strong>functions:config [function_name_or_id] [options] </strong></td> <td>プロジェクト内の関数に対してメモリ割り当てなどの高度な設定を行います</td> </tr> <tr> <td><strong>functions:shell [options]</strong></td> <td>Advanced I/O関数以外の任意のスタックまたはタイプのエミュレートされた関数をテストするためのnode shellを起動します</td> </tr> <tr> <td><strong>functions:delete [function_name_or_id] [options]</strong></td> <td>リモートコンソールまたはローカルディレクトリから関数を削除します</td> </tr> <tr> <td><strong>config:set &lt;key=value&gt; </strong></td> <td>Catalystの設定をキーと値のペアとして設定します</td> </tr> <tr> <td><strong>config:get &lt;key&gt;</strong></td> <td>指定されたキーのCatalyst設定値を取得します</td> </tr> <tr> <td><strong>config:list</strong></td> <td>すべてのCatalyst設定を一覧表示します</td> </tr> <tr> <td><strong>config:delete &lt;key&gt; </strong></td> <td>Catalyst設定からキーを削除します</td> </tr> <tr> <td><strong>appsail:add</strong></td> <td>既存のCatalystプロジェクトディレクトリをAppSailサービスに関連付けます</td> </tr> <tr> <td><strong>client:setup</strong></td> <td>プロジェクトディレクトリでクライアントディレクトリをセットアップおよび設定します</td> </tr> <tr> <td><strong>client:delete [client_version] [options]</strong></td> <td>リモートコンソールまたはローカルディレクトリからクライアントのバージョンを削除します</td> </tr> <tr> <td><strong>ds:import [~CSV_file_path] [options]</strong></td> <td>Catalyst Data Storeのテーブルにレコードを一括書き込みします</td> </tr> <tr> <td><strong>ds:export [options]</strong></td> <td>Catalyst Data Storeのテーブルからレコードを一括読み取りします</td> </tr> <tr> <td><strong>ds:status &lt;operation&gt; [job_id] [options]</strong></td> <td>Data Storeのインポートまたはエクスポート操作のジョブステータスを表示します</td> </tr> <tr> <td><strong>apig:enable</strong></td> <td>プロジェクトのAPI Gatewayを有効にします</td> </tr> <tr> <td><strong>apig:disable</strong></td> <td>プロジェクトのAPI Gatewayを無効にします</td> </tr> <tr> <td><strong>apig:status [options]</strong></td> <td>プロジェクトのAPI Gatewayの現在のステータスとスケジュールの進行状況を取得します</td> </tr> <tr> <td><strong>event:generate</strong> | <strong>generate:event &lt;source&gt; &lt;action&gt; [options]</strong></td> <td>Event関数をテストするために、さまざまなコンポーネントまたはカスタムイベントソースからサンプルペイロードを生成します</td> </tr> <tr> <td><strong>event:generate:integ &lt;service&gt; [options]</strong></td> <td>Integration関数をテストするために、必要な統合サービスのサンプルペイロードを生成します</td> </tr> <tr> <td><strong>event:generate:job</strong></td><td>Job関数をテストするためのサンプルペイロードを生成します</td> </tr> <tr> <td><strong>run-script</strong> | <strong>run [command]</strong></td> <td>catalyst.jsonで定義された特定のコマンドスクリプトを実行します</td> </tr> <tr> <td><strong>serve [options]</strong></td> <td>Basic I/O、Advanced I/O、BrowserLogic関数、AppSail、およびクライアントをローカルでテストするためにサーブします</td> </tr> <tr> <td><strong>deploy [options] [feature] </strong></td> <td>ローカルディレクトリからリモートコンソールにCatalystプロジェクトとプロジェクトリソースをデプロイします</td> </tr> <tr> <td><strong>help [command]</strong></td> <td>コマンドリファレンスまたは特定のコマンドのヘルプを表示します</td> </tr> <tr> <td><strong>logout</strong></td> <td>CLIをCatalystアカウントからログアウトします</td> </tr> <tr> <td><strong>codelib:install</strong></td><td>事前設定されたCatalyst CodeLibコンポーネントをプロジェクトにインストールします</td> </tr> </tbody> </table> 注意: Visual Studio Code IDEのユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してこれらのCLI操作を実行できます。Catalyst VS Code拡張機能の詳細は、このヘルプセクションをご覧ください。 -------------------------------------------------------------------------------- title: "CLIオプション" description: "Catalystは、さまざまな目的でCLIコマンドと一緒に使用できるいくつかのCLIオプションを提供しています。" last_updated: "2026-08-17T13:08:49.604Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/cli-options/" service: "All Services" -------------------------------------------------------------------------------- # CLIオプション Catalystは、CLIコマンドと一緒に使用できる以下のCLIオプションを提供しています。 ### -v | -\-version このオプションは、現在使用しているCatalyst CLIのバージョン番号を表示します。 -vまたは<br> -\\-versionをcatalystコマンドと以下のように使用できます。 catalyst --version <br /> <br /> ### -p | -\-project &lt;name\_or\_project\_id&gt; -\-org &lt;org\_id&gt; \-pまたは-\\-projectオプションは、CLIコマンドを実行するCatalystプロジェクトの名前またはIDを指定するために使用します。このオプションは、CLIで作業ディレクトリのプロジェクトを初期化またはアクティブにしていない場合に非常に便利です。また、トークンを使用してアクティブなログインセッションなしで、リモートコードリポジトリやCIシステムなどのリモートシステムからCatalyst CLIコマンドを実行する場合にも、このオプションを使用できます。 プロジェクトの初期化や有効化を行わずに、コマンドの対象となるプロジェクトを直接指定してCatalystコマンドを実行できます。プロジェクトの名前またはIDをオプションとともに指定する必要があります。 たとえば、*ShipmentTracking*というプロジェクトでAPI Gatewayを有効にするには、このオプションを使用して以下のCLIコマンドを実行できます。 catalyst apig:enable -p|--project ShipmentTracking また、オプションで-\\-orgオプションを使用して、プロジェクトが属し、CLIコマンドを実行するCatalyst組織のIDを指定することもできます。 たとえば、CLIからプロジェクトのWebクライアントをデプロイするには、これら両方のオプションを使用して以下のCLIコマンドを実行します。 catalyst deploy --only client -p|--project Test --org 72760298 <br> 注意:\-pまたは-\\-projectオプションの後に-\\-orgオプションを使用しない場合、コマンドの実行にはデフォルトの組織が使用されます。 <br /> <br /> ### -\-token &lt;token&gt; -\\-tokenオプションは、Catalyst CLIコマンドの実行を認証するために使用します。Catalyst CLIトークンを使用すると、アクティブなユーザーセッションにログインすることなく、CIツールなどのリモートシステムからCLIコマンドを実行できます。Catalyst CLIトークンの詳細については、トークンの使用のヘルプページをご覧ください。 CLIからユーザーアカウントにログインしている状態でトークンを生成する必要があります。その後、任意のリモートシステムからそのトークンを使用して、アクティブなログインセッションなしですべてのCLI操作を実行できます。これは、CLIコマンドの後にオプションとしてトークンを指定することで行われます。このトークンはそのユーザーアカウントの認証要素として機能し、指定したプロジェクトにコマンドの実行をマッピングし続けます。 たとえば、-\\-tokenオプションを使用して、リモートシステムからCatalystプロジェクトの関数コンポーネントをプロジェクトディレクトリに初期化できます。 catalyst init --only functions --token xxxxxxxxxxxxx これにより、Catalystはトークンを検証し、トークンが有効であれば初期化プロセスを開始します。 ### -\-dc&lt;us|eu|in|jp|sa|au|ca&gt; -\\-dc<us|eu|in|au|ca>オプションを使用すると、特定のDCログインからコマンドを実行できます。Catalystは現在、US、EU、IN、JP、SA、AU、CAの7つのデータセンターで利用可能です。通常、CLIにログインする際にアクセスするデータセンターを選択できます。 Catalystでは、各データセンターから同時に異なるログインを維持できます。つまり、両方のデータセンターにそれぞれ有効なトークンを1つずつ持ち、コマンドの実行を認証できます。その後、このオプションを使用してデータセンターを指定し、いずれかのデータセンターからコマンドを実行することを選択できます。 たとえば、EUとUS DCの両方に有効なログインがある場合、以下のようにコマンドを実行して、USデータセンターに関連付けられたユーザーアカウントのディレクトリにプロジェクトとそのリソースを初期化できます。 catalyst init --dc us これにより、Catalystは指定したデータセンターの資格情報を検証した後、プロジェクトを初期化します。 <br> 注意: 両方のデータセンターで異なるログインを維持しており、このオプションを使用してコマンドを実行するデータセンターを指定しない場合、デフォルトで最新のログインが使用されます。 ### -\-verbose -\\-verboseオプションは、CLIコマンドが実行されるときに行われるアクションに関する詳細情報を表示するために使用します。コマンド実行時にサーバーに送信されるHTTPリクエストの詳細、受信したレスポンスの詳細、CLI環境の詳細、サーバーへの接続に使用される認証トークン、設定されたCookieなどの情報が表示されます。 -\\-verboseオプションは、CLIコマンドの実行をデバッグおよびトラブルシューティングし、エラーの原因を特定するのに役立ちます。任意のCLIコマンドで-\\-verboseオプションを使用できます。 たとえば、verboseオプションを使用してプロジェクト一覧コマンドを実行できます。 catalyst project:list --verbose ### -h | -\-help -hまたは-\\-helpオプションは、CLIコマンドのヘルプを取得するために使用します。コマンドの機能の簡単な説明と、コマンドで使用可能なオプションとその構文が表示されます。 たとえば、catalyst functions:shellコマンドのヘルプが必要な場合は、以下のコマンドを実行できます。 catalyst functions:shell -h|--help <br /> catalyst help functions:shellを実行してコマンドのヘルプを取得することもできます。 -------------------------------------------------------------------------------- title: "ログインユーザーの識別" description: "このコマンドを使用して、現在CLIにログインしているユーザーアカウントの識別情報を確認できます。" last_updated: "2026-08-17T13:08:49.604Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/identify-loggedin-user/" service: "All Services" -------------------------------------------------------------------------------- # ログインユーザーの識別 ### コマンド実行 現在CLIにログインしているユーザーアカウントの識別情報を簡単に確認できます。 現在CLIにログインしているユーザーを識別するには、以下のコマンドを実行します。 catalyst whoami ログインしているユーザーのメールアドレスが表示されます。 <br> ### -\-dcオプションでの実行 -\\-dcオプションを付けてデータセンターを指定してこのコマンドを実行すると、そのデータセンターのユーザーログインのメールアドレスが返されます。 CLIオプションのヘルプページで説明されているように、Catalystでは複数のデータセンターの有効なログイントークンを同時に維持できます。そのため、あるデータセンターにあるユーザーアカウントでログインし、別のデータセンターに別のユーザーアカウントでログインしていた場合、catalyst whoamiコマンドは-\\-dcオプションと一緒に使用すると、そのデータセンターのユーザーログインを表示します。 特定のデータセンターに現在ログインしているユーザーを識別するには、以下のコマンドを実行します。 catalyst whoami --dc &lt;us|eu|in|jp|sa|ca|au&gt; <br /> 注意: Visual Studio Code IDEのユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEでwhoami操作を実行する手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "CLI設定" description: "Catalystでは、ローカルシステムにダウンロードされたPythonの場所を特定の設定ファイルで設定および管理できます。" last_updated: "2026-08-17T13:08:49.604Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/cli-config/" service: "All Services" -------------------------------------------------------------------------------- # CLI設定ファイル ### はじめに 設定ファイルとは、一般的にソフトウェアやコードベースの設定のパラメータと値を定義するファイルです。この場合、Catalystは、ローカルシステムにダウンロードされたPythonおよび特定のバージョンのJavaの場所を、特定の設定ファイルで設定および管理するためのCLIコマンドを提供します。 この特定の設定ファイルは、システムにインストールされたOSに基づいて、さまざまな場所にシステム内で管理される隠しローカルファイルです。システム内のさまざまなユーティリティの操作を制御します。また、システムがCLIと効果的に通信するための設定も含まれています。 注意: 現在、この設定ファイルにはPython、Java 11、Java 17、Java 21、またはJava 25のパス情報のみ設定できます。Catalystは現時点で、CLIを通じてこのファイルに他の情報を追加することをサポートしていません。 ### キーと値のペアの設定 キーと値のペアの形式で入力を提供することにより、ローカルマシンの設定ファイルにシステムに保存されているPython、Java 11、Java 17、Java 21、またはJava 25のパスを指定するエントリを追加できます。これを行うには、システムのターミナルから以下のコマンドを実行します。 catalyst config:set &lt;key=value&gt; 関数スタックのパス情報は以下の方法で設定できます。 - **Python**: catalyst config:set python3_9.bin=/Users/amelia-426/Downloads/Python-3.9.16 - **Java 8**: catalyst config:set java8.bin=/Library/Java/JavaVirtualMachines/jdk1.8.0_291.jdk/Contents/Home/bin - **Java 11**: catalyst config:set java11.bin=/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin - **Java 17**: catalyst config:set java17.bin=/Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home/bin - **Java 21**: catalyst config:set java21.bin=/Library/Java/JavaVirtualMachines/jdk-21.jdk/Contents/Home/bin - **Java 25**: catalyst config:set java25.bin=/Library/Java/JavaVirtualMachines/jdk-25.jdk/Contents/Home/bin <br /> 注意: * 現在、キーとして設定できるのはpython3_9.bin、java8.bin、java11.bin、java17.bin、java21.bin、またはjava25.binのみです * 上記のコマンドに記載されているパスをお使いのJDKまたはPythonのパスに置き換えてください * ローカルシステムがWindows OSで動作している場合は、パスをダブルクォーテーションで囲んでください。たとえば、Java 11のパスは以下のように設定します:<br /> catalyst config:set java11.bin="/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin" <br> ### 特定のキーの値の取得 以下のターミナルコマンドをキーとともに実行することで、この特定の設定ファイル内の任意のキーの値を取得できます。 catalyst config:get &lt;key&gt; - **Python**: catalyst config:get python3_9.bin - **Java 8**: catalyst config:get java8.bin - **Java 11**: catalyst config:get java11.bin - **Java 17**: catalyst config:get java17.bin - **Java 21**: catalyst config:get java21.bin - **Java 25**: catalyst config:get java25.bin <br /> 設定ファイルに保存されているキーのパスまたは値が返されます。たとえば: - **Python**: /Users/amelia-426/Downloads/Python-3.9.16 - **Java 8**: /Library/Java/JavaVirtualMachines/jdk1.8.0_291 - **Java 11**: /Library/Java/JavaVirtualMachines/jdk-11.0.17 - **Java 17**: /Library/Java/JavaVirtualMachines/jdk-17 - **Java 21**: /Library/Java/JavaVirtualMachines/jdk-21 - **Java 25**: /Library/Java/JavaVirtualMachines/jdk-25 注意: * 現在、このCLIコマンドを使用してこのファイルから取得できるのは、Python、Java 8、Java 11、Java 17、Java 21、またはJava 25のパス情報のみです。 * 上記のコマンドに記載されているパスをお使いのJDKまたはPythonのパスに置き換えてください * ローカルシステムがWindows OSで動作している場合は、パスをダブルクォーテーションで囲んでください。たとえば、Java 11のパスは以下のように設定します:<br /> catalyst config:get java11.bin="/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin" <br> ### 設定の一覧表示 以下のコマンドを実行することで、設定ファイルに存在するすべての設定（キーと値のペア）のリストを取得できます。 catalyst config:list <br /> 注意: 現在、このCLIコマンドはシステム内のPython、Java 8、Java 11、Java 17、Java 21、またはJava 25のパスの設定情報のみを取得します。 <br> ### キーの削除 以下のCLIコマンドを実行することで、設定ファイル内のエントリを削除できます。 catalyst config:delete &lt;key&gt; <br /> 削除するエントリのキー名を指定する必要があります。 * **Python**: catalyst config:delete python3_9.bin * **Java 8**: catalyst config:delete java8.bin * **Java 11**: catalyst config:delete java11.bin * **Java 17**: catalyst config:delete java17.bin これにより、ファイルからキーと値のペアが削除されます。 <br /> -------------------------------------------------------------------------------- title: "AppSailサービスの追加" description: "Java、Node.js、PythonのCatalystマネージドランタイム、またはOCIイメージとしてのカスタムランタイムで、Catalyst AppSail Webサービスをプロジェクトディレクトリに追加し、クラウドにデプロイします。" last_updated: "2026-08-17T13:08:49.604Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/add-appsail/" service: "All Services" -------------------------------------------------------------------------------- # AppSailサービスの追加 ### はじめに AppSailは、あらゆる規模のWebサービスをクラウドにデプロイし、そのプラットフォームインスタンスを管理するために使用できるCatalystのサーバーレスプラットフォームです。AppSailサービスは、次の2つの方法のいずれかで初期化できます。 * Catalystマネージドランタイムとして：Catalystがサポートする特定のJava、Node.js、Pythonランタイムのアプリケーションを初期化し、リモートコンソールに直接デプロイします * コンテナイメージとして：ローカルレジストリから任意のランタイムまたはフレームワークのアプリケーションのOCIイメージを初期化し、リモートコンソールにデプロイします 注意: Catalystは、Linux AMD64（x86-64）プラットフォーム向けにビルドされたOCI準拠のイメージのデプロイのみをサポートしています。 どちらの場合も、デプロイ準備が整ったアプリのAppSailサービスを初期化し、このコマンドを使用してCatalystプロジェクトに関連付けることができます。 情報: このコマンドを使用して、既存のCatalystプロジェクトディレクトリにAppSailサービスを追加できます。最初にプロジェクトを初期化した際にAppSailを初期化しなかった場合や、最初のAppSailサービスの後に追加のAppSailサービスを追加する場合に使用できます。まだプロジェクトを初期化していない場合は、最初に初期化する必要があります。また、スタンドアロンコマンドを使用して、初期化なしでアプリを直接デプロイすることもできます。 既存のCatalystプロジェクトディレクトリで次のCLIコマンドを実行して、AppSailサービスを追加できます。 catalyst appsail:add <br> ### CatalystマネージドランタイムとしてAppSailを追加 Catalystマネージドランタイム用のAppSailサービスを、アプリのディレクトリ内で直接、または新しいディレクトリから初期化できます。プロジェクトの初期化時にAppSailを選択していた場合、Catalystはクライアントの初期化後にセットアップを行います。 Catalystは、この方法でAppSailサービスが初期化されると、app-config.jsonファイルを作成します。 1. CLIは、ランタイムタイプとして**Catalyst-Managed Runtime**または**Docker Image**を選択するよう求めます。最初のオプションを選択してください。 2. 「Y」を入力して**Enter**を押すと、既製のサンプルプロジェクトで開始できます。次に、リストからサンプルアプリを選択します。 サンプルアプリがディレクトリにダウンロードされます。プロンプトが表示されたら、名前を入力してください。 独自のアプリを初期化する場合は、「N」を入力して**Enter**を押してください。 3. 「Y」を入力して、ここがアプリのソースディレクトリかどうかを選択します。「N」を入力すると、CLIはディレクトリ内のアプリのソースの絶対パスを入力するよう求めます。入力後に**Enter**を押してください。 4. アプリの名前を入力します。アプリのビルドのメインファイルには、任意の名前を付けることができます。 注意: アプリをJava WARファイルとしてビルドする場合、メインファイルをroot.warと名付けるか、コードに応じて特定のコントローラーを追加する必要があります。 5. アプリの絶対ビルドパスを入力し、**Enter**を押してください。 6. アプリのスタックとランタイムを選択し、**Enter**を押してください。 Javaを選択した場合、CLIはさらに**Java SE**または**Java WAR**をアプリのデプロイ可能な形式として選択するよう求めます。これについての詳細はこちらをご覧ください。 他のスタックを選択した場合、このステップはスキップされます。 AppSailが選択したソースディレクトリに追加され、アプリがCatalystプロジェクトに関連付けられました。設定はcatalyst.jsonファイルに更新されます。 Catalystは、この方法でAppSailサービスが追加されると、app-config.jsonファイルを作成します。これは、アプリのソースディレクトリ内のAppSail固有の唯一のファイルになります。デプロイ前に、このファイルでスタートアップコマンド、環境変数、メモリなどの値を編集できます。 <br> ### カスタムランタイムとしてAppSailを追加 新しいディレクトリから、アプリの準拠OCIイメージ用にAppSailを初期化できます。Catalystは、アプリのイメージをAppSailに関連付けるために使用できる2つのプロトコルをサポートしています。各プロトコルには、識別と機能のための個別のスキーマがあります。 * Docker Imageプロトコル: ローカルDockerレジストリに存在するアプリの事前ビルドされたイメージを関連付けるために使用します。イメージはビルドされ、ローカルレジストリを指すようにタグ付けされている必要があります。例: *docker://localhost/expres-hw:latest* * Docker Archiveプロトコル: システムのディレクトリにあるアプリの事前ビルドされたイメージのアーカイブファイル（.tarまたは.tar.gz）を指定するために使用します。例: *docker-archive://test.tar* 注意: .tarファイルは、通常docker saveコマンドで生成できます。 コンテナイメージのAppSailでは、名前以外の詳細を提供する必要はありません。OCIイメージではすでに定義されているため、アプリのソースまたはビルドパス、スタック、スタートアップコマンドの設定は不要です。 1. CLIは、ランタイムタイプとしてCatalyst-Managed Runtimeまたは**Docker Image**を選択するよう求めます。2番目のオプションを選択してください。 2. プロトコルとして**Docker Image**または**Docker Archive**を選択します。 3. Docker Imageプロトコル: **Docker Image**を選択した場合、CLIはローカルDockerレジストリ内の利用可能なすべてのイメージとタグを一覧表示します。必要なイメージを選択してください。 Docker Archiveプロトコル: **Docker Archive**を選択した場合、CLIはローカルシステム内のアプリのTARファイルイメージの絶対パスを入力するよう求めます。 注意: AppSailの設定がcatalyst.jsonファイルに保存される場合、パスはそのファイルの場所からの相対パスとして保存されます。 4. AppSailサービスの名前を入力します。任意の名前を付けることができます。 AppSailがローカルディレクトリに追加され、アプリのイメージがAppSailサービスに関連付けられました。設定はcatalyst.jsonファイルに更新されます。 注意: コンテナイメージでAppSailを追加した場合、app-config.jsonファイルは作成されません。すべてのアプリの仕様はcatalyst.jsonファイルに保存されます。このファイルでアプリの特定のカスタム設定を追加できます。詳細はこちらを参照してください。 アプリにビジネスロジックをコーディングし、localhostを通じてAppSailサービスをサーブしてデバッグおよびテストするか、リモートコンソールに直接デプロイできます。 -------------------------------------------------------------------------------- title: "Catalyst Signalsでのペイロード生成" description: "Catalystでは、CLIを使用してCatalyst SignalsのCatalyst Publishersがサポートするさまざまなイベントソースからサンプルペイロードを生成できます。" last_updated: "2026-08-17T13:08:49.605Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/gen-payload-catalyst-publishers/" service: "All Services" related: - Catalyst Signals (/ja/signals/help/events/) -------------------------------------------------------------------------------- # Catalyst Publishersのイベント用サンプルペイロード Catalyst SignalサービスのCatalyst Publishersによってソースされるイベントについて、以下のCLIコマンドを使用してサンプルペイロードを生成できます。 catalyst signals:generate &lt;publisher_service&gt; &lt;event_name&gt; このCLIコマンドで生成されたサンプルペイロードは、要件に応じてイベント関数の機能をテストするために使用できます。 サンプルペイロードは、以下のCatalyst Cloud Scaleコンポーネントに対してのみ生成できます。 * DataStore * Stratus * Cache * Authentication 以下の表は、catalyst signals: generateコマンドを使用してサンプルペイロードを生成できるイベントの詳細を示しています。 <table border="1" cellpadding="8" cellspacing="0"> <thead> <tr> <th class="w25p">パブリッシャーサービス</th> <th class="w25p">イベント名</th> <th class="w40p">イベントアクション</th> </tr> </thead> <tbody> <tr> <td rowspan="3">DataStore</td> <td>row_inserted</td> <td>テーブルに行が挿入されたとき</td> </tr> <tr> <td>row_updated</td> <td>テーブルの行が更新されたとき</td> </tr> <tr> <td>row_deleted</td> <td>テーブルから行が削除されたとき</td> </tr> <tr> <td rowspan="4">Stratus</td> <td>stratus_object_uploaded</td> <td>Stratusのバケットにオブジェクトがアップロードされたとき</td> </tr> <tr> <td>stratus_object_downloaded</td> <td>Stratusのバケットからオブジェクトがダウンロードされたとき</td> </tr> <tr> <td>stratus_object_updated</td> <td>Stratusのオブジェクトが更新されたとき</td> </tr> <tr> <td>stratus_object_deleted</td> <td>Stratusからオブジェクトが削除されたとき</td> </tr> <tr> <td rowspan="2">Cache</td> <td>cache_item_created</td> <td>キャッシュアイテムが作成されたとき</td> </tr> <tr> <td>cache_item_updates</td> <td>キャッシュが更新されたとき</td> </tr> <tr> <td rowspan="3">Authentication</td> <td>user_signedup</td> <td>ユーザーがアプリケーションにサインアップしたとき</td> </tr> <tr> <td>user_confirmed</td> <td>ユーザーが検証プロセスを完了したとき</td> </tr> <tr> <td>user_deleted</td> <td>ユーザーがアプリケーションから削除されたとき</td> </tr> </tbody> </table> たとえば、Stratusのバケットにオブジェクトがアップロードされたときにトリガーされるイベント関数の機能をテストするためのサンプルペイロードを生成する必要がある場合、CLIコマンドは以下のようになります。 catalyst signals: generate stratus stratus_object_upload **出力例**: 以下のJSONスニペットは、期待される出力の例を示しています。 { "rule_id": "534143331281450898", "target_id": "33038437", "version": 1, "attempt": 1, "account": { "org_id": "96858155", "project": { "environment": "Development", "name": "Project-Rainfall", "id": "11365000000016052" } }, "events": [ { "data": { "action_time": "7437648374832", "bucket_details": { "bucket_name": "sample-bucket", "project_details": { "id": "11365000000016052", "project_name": "Project-Rainfall", "project_type": "Live" }, "created_by": { "email_id": "emmy@zylker.com", "user_type": "Admin", "user_id": "193334093726081", "is_confirmed": true, "last_name": "66028", "first_name": "97b6bc29b3", "zuid": "2369563417" }, "created_time": "May 23, 2025 06:21 PM", "modified_by": { "email_id": "emmy@zylker.com", "user_type": "Admin", "user_id": "193334093726081", "is_confirmed": true, "last_name": "66028", "first_name": "97b6bc29b3", "zuid": "2369563417" }, "modified_time": "May 23, 2025 06:21 PM", "bucket_meta": { "versioning": false, "caching": { "status": "Disabled" }, "encryption": false, "audit_consent": false } }, "object_key": "path1/path2/myfile.png" }, "id": "7a66cb17-967b-5ccd-dad0-34c34e63e5a", "time_in_ms": "1748004702399", "source": "publisher_id:51607702502369250/service:cloudscalestratus/account:41005674", "event_config": { "api_name": "stratus_object_uploaded", "id": "57515236254614294" } } ] } ### カスタムイベント用サンプルペイロード カスタムアプリケーションやコンポーネントによってソースされるイベントのサンプルペイロードを生成するには、以下の方法でcatalyst signals:generate CLIコマンドを使用できます。 catalyst signals:generate custom &lt;custom_event&gt; カスタムイベントのペイロードを生成するには、カスタムイベントを定義する必要があります。つまり、カスタムパブリッシャー内で必要なイベントのREST APIキーを定義および設定する必要があります。 詳細:<br /> * カスタムイベント * カスタムパブリッシャー * カスタムイベントへのスキーマの追加 以下の例を考えてみましょう。エンドユーザーの食事を追跡し、栄養に関する推奨を提供する別のアプリケーションがあるとします。エンドユーザーが食事プランを登録した際に、適切なロジックがトリガーされる必要があるという要件があります。この場合、イベントスキーマと必要なREST APIキーを定義および設定していれば、以下の方法でCatalyst CLIを使用してこのイベントのサンプルペイロードを生成できます。 catalyst signals:generate custom diet_profile_registered **出力例**: 以下のJSONスニペットは、期待される出力の例を示しています。 { "rule_id": "382913648739323890", "target_id": "70141764", "version": 1, "attempt": 1, "account": { "org_id": "60047207190", "project": { "environment": "Development", "name": "Project-Rainfall", "id": "21256000000010040" } }, "events": [ { "data": {}, "id": "53aea689-77ac-fd4b-560d-82fd532bd1a", "time_in_ms": "1760089550627", "source": "publisher_id:90216327659515060/service:custom", "event_config": { "api_name": "diet_profile_registered", "id": "97690672393764451" } } ] } -------------------------------------------------------------------------------- title: "CLIログアウト" description: "logoutコマンドを実行することで、CLIのアクティブなアカウントからログアウトできます。" last_updated: "2026-08-17T13:08:49.605Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/logout/" service: "All Services" -------------------------------------------------------------------------------- # CLIログアウト ### コマンド実行 ターミナルの実行を終了する前に、CLIからログアウトできます。ログアウトすると、ログインしているユーザーアカウントの資格情報を含む認証トークンが取り消されます。再度ログインすると、セッション用の新しいトークンが生成されます。 CLIからログアウトするには、以下のコマンドを実行します。 catalyst logout <br> CLIが確認を求めます。Yを押してからEnterを押してください。 <br> ユーザーアカウントがCLIからログアウトされます。CLIはログアウトしたことを確認するメッセージを表示します。 catalyst login コマンドを使用して、CLIに再度ログインできます。 注意: Visual Studio Code IDEのユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalystからログアウトする手順はこちらをご覧ください。 ### API Gatewayの操作 -------------------------------------------------------------------------------- title: "はじめに" description: "Catalyst CLIは、API Gatewayの有効化・無効化、およびローカル環境でのAPI作成ステータスの取得オプションを提供します。" last_updated: "2026-08-17T13:08:49.605Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-api-gateway/introduction/" service: "All Services" -------------------------------------------------------------------------------- # API Gatewayの操作 ### はじめに Catalystは、クライアントアプリケーションやマイクロサービスから生成されるHTTPリクエストの作成、維持、監視を可能にする高度なAPI管理ツールとしてAPI Gatewayを提供しています。Catalyst API Gatewayは、Basic I/OおよびAdvanced I/Oファンクション、およびアプリケーションのWebクライアントコンポーネントにアクセスするためのエントリポイントとして機能します。 このコンポーネントの詳細については、 **API Gatewayヘルプドキュメント** を参照してください。 CLIは、アプリケーションのAPI Gatewayで次のアクションを実行するためのオプションを提供しています： * API Gatewayの有効化 * API Gatewayのステータスとスケジュール進捗の取得 * API Gatewayの無効化 プロジェクトでAPI Gatewayを有効にすると、アプリケーションで作成した各APIの定義を含むJSONファイルをプロジェクトディレクトリにセットアップできるようになります。これについてはこのヘルプドキュメントで詳しく説明します。ファンクションやクライアントコンポーネントと同様に、ローカル環境からこのJSONを操作し、リモートコンソールにデプロイできます。 リモートコンソールで作成された最新のAPI定義をローカルプロジェクトディレクトリにプルし、API Gateway JSONファイルを更新することもできます。詳細については、リソースのプルのヘルプページを参照してください。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールすると、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用したAPI Gatewayの操作手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "API Gatewayの有効化" description: "Catalyst CLIは、API Gatewayの有効化・無効化、およびローカル環境でのAPI作成ステータスの取得オプションを提供します。" last_updated: "2026-08-17T13:08:49.605Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-api-gateway/enable-api-gateway/" service: "All Services" -------------------------------------------------------------------------------- # API Gatewayの有効化 API Gatewayが無効になっている場合、CLIからプロジェクトのAPI Gatewayを有効にできます。初めてアクセスする前に有効にする必要があります。 注意: CatalystアプリケーションのAPI Gatewayを有効にすると、Security Rulesの設定は自動的に無効になります。Catalystプロジェクトでホストされているファンクションとwebクライアントは、APIを作成するまですぐにアクセスできなくなります。そのため、慎重に進めてください。API Gatewayを有効にした直後に、すべてのファンクションとWebクライアントのAPIを作成してください。また、その間にエンドユーザーがそれらにアクセスしないようにしてください。 <br> プロジェクトのAPI Gatewayを有効にするには、プロジェクトディレクトリから次のコマンドを実行します： catalyst apig:enable <br> CLIはコンポーネントを有効にし、API Gatewayのステータスで設定ファイルを更新します。これにより、リモートコンソールでもAPI Gatewayが有効になります。 <br> プロジェクトのAPI Gatewayのステータスは、プロジェクトディレクトリのcatalyst.jsonファイルでいつでも確認できます。apig設定のenabledパラメータがtrueに更新されます。 <br /> 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールすると、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用したAPI Gatewayの操作手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "API Gatewayステータスの取得" description: "Catalyst CLIは、API Gatewayの有効化・無効化、およびローカル環境でのAPI作成ステータスの取得オプションを提供します。" last_updated: "2026-08-17T13:08:49.605Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-api-gateway/obtain-api-gateway-status/" service: "All Services" -------------------------------------------------------------------------------- # API Gatewayステータスの取得 ### コマンドの実行 プロジェクトのAPI Gatewayの現在のステータスを取得して、有効か無効かを確認できます。API Gatewayで自動作成プロセスなど、API作成が進行中の場合は、スケジュール進捗のステータスも表示され、現在の状態が通知されます。 プロジェクトのAPI Gatewayのステータスとスケジュール進捗を取得するには、プロジェクトディレクトリから次のコマンドを実行します： catalyst apig:status 現在のステータスが表示されます。 <br /> ### API Gatewayステータスオプション 次のオプションを指定して$ catalyst apig:statusを実行することで、現在のステータスの代わりに、プロジェクトのAPI Gatewayの以前のスケジュールステータスを取得することもできます： catalyst apig:status --previous これにより、API Gatewayコンポーネントの以前に記録されたステータスが表示されます。コンポーネントが以前に無効化または有効化されていた場合、CLIはその旨を通知します。 <br /> 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールすると、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用したAPI Gatewayの操作手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "API Gateway JSONファイル" description: "Catalyst CLIは、API Gatewayの有効化・無効化、およびローカル環境でのAPI作成ステータスの取得オプションを提供します。" last_updated: "2026-08-17T13:08:49.606Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-api-gateway/api-gateway-json-file/" service: "All Services" -------------------------------------------------------------------------------- # API Gateway JSONファイル はじめにで述べたように、アプリケーションのAPI Gatewayコンポーネントで作成された各APIの定義を含むJSONファイルをプロジェクトディレクトリに含めることができます。このcatalyst-user-rules.json ファイルは、プロジェクトのホームディレクトリに作成されます。 プロジェクトでAPIをまだ作成していない場合でも、catalyst pull コマンドを使用して、サンプルAPI定義を含むcatalyst-user-rules.jsonファイルを取得できます。 このファイルには、カスタムAPIがまだ作成されていない場合でも、Login Redirectと呼ばれるデフォルトAPIの定義が含まれます。Basic I/OおよびAdvanced I/Oファンクションのサンプル定義も含まれます。リモートコンソールでカスタムAPIが作成されている場合、その最新の定義がプロジェクトディレクトリにプルされます。 JSONファイルには、APIのソース、ターゲット、リクエストメソッド、および設定されている場合はスロットリング制限とリクエストプロセッサの詳細が含まれます。 ローカル環境で新しいAPIを定義したり、既存のAPI定義を変更したりして、catalyst deployコマンドを使用してAPI Gatewayルールをデプロイすることでリモートコンソールに更新できます。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールすると、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用したAPI Gatewayの操作手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "API Gatewayの無効化" description: "Catalyst CLIは、API Gatewayの有効化・無効化、およびローカル環境でのAPI作成ステータスの取得オプションを提供します。" last_updated: "2026-08-17T13:08:49.606Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-api-gateway/disable-api-gateway/" service: "All Services" -------------------------------------------------------------------------------- # API Gatewayの無効化 CLIからいつでもプロジェクトのAPI Gatewayを無効にできます。これにより、Security Rulesで設定された定義がすぐに再有効化されます。 注意: API Gatewayを無効にした後に再度有効にすると、以前に作成したすべてのAPIは引き続き利用可能で、API Gatewayの再有効化時にすぐに再有効化されます。同じAPIを再度作成する必要はありません。 <br> プロジェクトのAPI Gatewayを無効にするには、プロジェクトディレクトリから次のコマンドを実行します： catalyst apig:disable <br> CLIはコンポーネントを無効にし、 catalyst.json ファイルをAPI Gatewayのステータスで更新します。apig設定のenabledパラメータがfalseに更新されます。これにより、リモートコンソールでもAPI Gatewayが無効になります。 <br /> 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールすると、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用したAPI Gatewayの操作手順はこちらをご覧ください。 ### CLIヘルプ -------------------------------------------------------------------------------- title: "コマンドリファレンスヘルプ" description: "Catalystは、コマンドリファレンス、コマンド構文ヘルプ、ヘルプオプション、コンテキスト依存ヘルプなど、CLIコマンド実行のためのさまざまなヘルプオプションを提供します。" last_updated: "2026-08-17T13:08:49.607Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/cli-help/command-reference-help/" service: "All Services" -------------------------------------------------------------------------------- # コマンドリファレンスヘルプ ### コマンドリファレンスの表示 Catalystは、CLIコマンド実行のためのさまざまなヘルプオプションを提供します。コマンドリファレンスの取得や、特定のコマンドで利用可能なオプションの一覧など、CLI操作でヘルプが必要な場合にいつでもこれらのオプションを使用できます。 利用可能なすべてのCLIコマンドとその構文、およびコマンドの簡単な説明と実行されるアクションを一覧表示するコマンドリファレンスを簡単に取得できます。これにより、任意のCLIコマンドで使用できる一般的なCLIオプションとその説明も一覧表示されます。 <br> コマンドリファレンスを表示するには、任意のディレクトリから以下のコマンドを実行します。 catalyst help <br> インストールされているCLIバージョンで利用可能なすべてのコマンドとオプションが表示されます。 -------------------------------------------------------------------------------- title: "コマンド構文とオプションヘルプ" description: "Catalystは、コマンドリファレンス、コマンド構文ヘルプ、ヘルプオプション、コンテキスト依存ヘルプなど、CLIコマンド実行のためのさまざまなヘルプオプションを提供します。" last_updated: "2026-08-17T13:08:49.607Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/cli-help/command-syntax-and-options-help/" service: "All Services" -------------------------------------------------------------------------------- # コマンド構文とオプションヘルプ 特定のコマンドのヘルプを取得することもできます。コマンドの目的に関する簡単な使用方法の説明と、そのコマンドで利用可能なオプションとその構文が一覧表示されます。catalyst helpの後にコマンドを指定することで、このヘルプにアクセスできます。 <br> たとえば、catalyst serveのヘルプが必要な場合は、以下のコマンドを実行します。 catalyst help serve <br> コマンドの簡単な説明と、サポートするオプションが一覧表示されます。 -------------------------------------------------------------------------------- title: "ヘルプオプション" description: "Catalystは、コマンドリファレンス、コマンド構文ヘルプ、ヘルプオプション、コンテキスト依存ヘルプなど、CLIコマンド実行のためのさまざまなヘルプオプションを提供します。" last_updated: "2026-08-17T13:08:49.607Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/cli-help/help-option/" service: "All Services" -------------------------------------------------------------------------------- # ヘルプオプション コマンドを入力した後に-hまたは<br> -\\-helpオプションを続けることで、特定のコマンドのヘルプを取得することもできます。これは、前のセクションで説明したコマンド構文とオプションヘルプと同じ機能を実行します。 たとえば、catalyst functions:shellコマンドのヘルプが必要な場合は、以下のコマンドを実行します。 catalyst functions:shell --help|-h これについては、CLIオプションのドキュメントで詳しく説明されています。 -------------------------------------------------------------------------------- title: "コンテキスト依存ヘルプ" description: "Catalystは、コマンドリファレンス、コマンド構文ヘルプ、ヘルプオプション、コンテキスト依存ヘルプなど、CLIコマンド実行のためのさまざまなヘルプオプションを提供します。" last_updated: "2026-08-17T13:08:49.607Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/cli-help/context-sensitive-help/" service: "All Services" -------------------------------------------------------------------------------- # コンテキスト依存ヘルプ Catalystは、CLIコマンドの実行中にエラーが発生した場合にも、コンテキスト依存ヘルプを提供します。Catalystはエラーの原因を特定するだけでなく、エラーを修正または防止するために実行できるアクションのヘルプ、および特定のアクションのドキュメントへのヘルプリンクも提供します。 これについては、CLIコンテキスト依存ヘルプのページで詳しく説明されており、各コマンド実行中に発生する可能性のあるエラーの一覧も含まれています。 ### CLIログイン -------------------------------------------------------------------------------- title: "Catalyst CLIからのログイン" description: "ターミナルからCLIコマンドを実行する前に、Catalyst CLIへのログインについて学びます。" last_updated: "2026-08-17T13:08:49.607Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/login/login-from-cli/" service: "All Services" -------------------------------------------------------------------------------- # Catalyst CLIからのログイン ### はじめに Catalyst CLIの使用を開始する前に、CLIでCatalystアカウントにログインする必要があります。これにより、CLIがオンラインのZohoアカウントに接続されます。CLIからログインすると、システムのターミナルから直接Catalystプロジェクトで作業できます。CLIで行った変更は、デプロイ時にオンラインのCatalystアカウントに反映・同期されます。 ### ログイン手順 CLIからオンラインのZohoアカウントにログインするには： 1. ターミナルで以下のコマンドを実行します： catalyst login 2. CatalystにCLIエラーレポート情報の収集を許可するよう求められます。Yを押してCatalystにCLIエラーレポート情報の収集を許可し、Enterを押します。許可を拒否するには、Nを押してからEnterを押します。 3. CLIは次に、Catalystにアクセスするデータセンターを選択するよう求めます。アカウントが属するデータセンターに基づいてUS、EU、IN、JP、SA、AU、またはCAを選択し、Enterを押します。 自動的にブラウザウィンドウにリダイレクトされ、Zoho Accountsのログインページが開きます。自動的にリダイレクトされない場合は、「Visit this URL on this device to login」の下に表示されるURLにアクセスしてください。<br /> 注意: エラーレポート情報の他にも、CatalystはCLIのパフォーマンスと動作、コマンドログ、その他の必須情報を収集します。これらはCatalystサポートにトラブルシューティングを依頼する際のバグ修正に役立ちます。この時点で許可を拒否した場合、再度許可するにはログアウトして再ログインするか、強制ログインを実行する必要があります。データは、CLIの認証が完了した後にのみCatalystサーバーに送信されます。 4. Zohoアカウントにログインしていない場合は、Zoho Accountsのログインページで資格情報を使用してサインインします。 5. Catalyst CLIがZohoアカウントのデータへのアクセス許可をリクエストするページにリダイレクトされます。Acceptをクリックして、Catalyst CLIにこれらの許可を付与します。<br /> <br> 6. ログインが成功すると、Catalyst CLIのログイン成功メッセージが表示される画面にリダイレクトされます。<br /> 7. ウィンドウを閉じて、ターミナルでCLIを引き続き使用します。CLIにもログイン成功メッセージが表示されます。<br /> 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してこれらのCLI操作を実行できます。Visual Studio Code IDEを通じてCatalystにログインする手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "ログインオプション" description: "ターミナルからCLIコマンドを実行する前に、Catalyst CLIへのログインについて学びます。" last_updated: "2026-08-17T13:08:49.607Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/login/options/" service: "All Services" -------------------------------------------------------------------------------- # ログインオプション Catalyst CLIでは、catalyst loginコマンドで以下のオプションを使用できます。 ### -\-no-localhost Catalystでは、別のデバイスを使用してCLIにログインする利便性を提供しています。別のデバイスで資格情報を入力してログインした後、現在のデバイスでCLIを引き続き使用できます。 これは、現在のデバイスでサーバーにアクセスしたりブラウザを使用したりできない場合に非常に便利です。また、ユーザーアカウントのCLIへのアクセスを別のコラボレーターに提供する必要がある場合にも、このオプションを使用できます。 ブラウザを使用せずにCLIにログインするには、catalyst loginコマンドに-\\-no-localhostオプションを付けて以下のように実行します： catalyst login --no-localhost このコマンドを実行すると、CatalystにCLIエラーレポート情報の収集を許可するよう求められます。Yを押してCatalystにCLIエラーレポート情報の収集を許可し、Enterを押します。許可を拒否するには、Nを押してからEnterを押します。 <br> CLIは次に、Catalystにアクセスするデータセンターを選択するよう求めます。お住まいの場所に基づいてUS、EU、AU、JP、SA、IN、またはCAデータセンターを選択し、Enterを押します。 Catalystがデバイス用のURLと認証コードを提供します。Zoho Accountsページに接続できる任意のデバイスからURLにアクセスできます。 <br> Catalystが提供した認証コードをそのページに入力し、Verifyをクリックします。 <br> その後、サインインページにリダイレクトされ、アカウントの資格情報を使用してログインできます。アカウントがすでにログインしている場合、CLIはそのアカウントに自動的に関連付けられます。Catalyst CLIがZohoアカウントのデータにアクセスするための許可を求められます。 許可を付与すると、ブラウザウィンドウにデバイスが承認されたことを確認するメッセージが表示されます。 <br> これで、現在のデバイスからCLIの使用を開始できます。 <br> ### -\-force ユーザー認証で問題が発生し、ターミナルが再認証を求める場合、ログアウトして再ログインする代わりに、強制ログインオプションを使用できます。強制ログインは、そのデータセンターの現在の認証資格情報（グラントトークンやアクセストークンなど）を破棄し、Catalystアカウントにユーザーを最初からログインし直します。 また、このオプションを使用して、異なるデータセンターからの異なるログインを同時に維持することもできます。つまり、単一のデータセンターで1つの有効なトークンを持ち、コマンド実行を認証できます。あるアカウントでデータセンターにすでにログインしている場合、別のデータセンターに強制ログインすると、両方の認証トークンが有効になります。その後、コマンドでオプションとして指定することで、いずれかのデータセンターからコマンドを実行できます。 注意: * データセンターごとにログインできるアカウントは1つだけです。同じデータセンターから複数のログインを維持することはできません。 * 異なるデータセンターで異なるログインを維持しており、このコマンドを実行するデータセンターを指定するオプションを使用しない場合、デフォルトで最新のログインが使用されます。 CLIで強制ログインを実行するには、catalyst loginコマンドに\--forceオプションを付けて以下のように実行します： catalyst login --force コマンドを実行した後、catalyst loginと同じ手順に従って、CLIからオンラインのZohoアカウントにログインします。 ### Data Storeのインポートとエクスポート -------------------------------------------------------------------------------- title: "はじめに" description: "Catalystでは、CLIを使用してData Storeのテーブルに対して一括読み取りおよび一括書き込み操作を実行できます。" last_updated: "2026-08-17T13:08:49.607Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/data-store-import-and-export/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Data Storeのインポートとエクスポート ### はじめに Catalystでは、CLIを使用してCatalyst Data Storeのテーブルに対して一括読み取りおよび一括書き込み操作を実行できます。 * Data Storeインポート: インポート操作は、StratusのBucketにアップロードされたCSVファイルから数千件のレコードを取得し、Data Storeの特定のテーブルに一括書き込みできます。インポート操作が正常に実行された後、ジョブ実行の詳細を含むCSVレポートファイルがダウンロードURLに生成されます。 * Data Storeエクスポート: エクスポート操作は、Data Storeの特定のテーブルから数千件のレコードを一括読み取りし、ジョブが成功した場合は読み取り操作の結果を含むCSVファイルを生成します。 両方のインポートおよびエクスポート操作の具体的な要件は、オプションの入力JSON設定ファイルで定義でき、CLIコマンドと一緒に渡すことができます。設定ファイルを渡さない場合は、コマンド実行のオプションで必須情報を指定する必要があります。 両方の操作でコールバックURLを設定して、ジョブステータスのレスポンスを自動的に投稿できるようにすることができます。また、必要に応じてジョブ実行ステータスを手動で確認することもできます。 注意: Catalystは、Data Storeのインポートおよびエクスポート操作用のAPIも提供しています。個別のAPIを使用して、両方の操作のジョブの作成、ステータスの確認、結果のダウンロードを行うことができます。詳細については、Bulk Read APIおよびBulk Write APIのドキュメントを参照してください。 -------------------------------------------------------------------------------- title: "インポート操作" description: "Catalystでは、CLIを使用してData Store内のテーブルに対して一括読み取りおよび一括書き込み操作を実行できます。" last_updated: "2026-08-17T13:08:49.607Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/data-store-import-and-export/import-operation/" service: "All Services" -------------------------------------------------------------------------------- # Data Storeインポート Data Storeインポートコマンドの一般的な構文は以下の通りです。 catalyst ds:import [CSV_file_path] [options] コマンドの実行について説明する前に、このコマンドで利用可能な操作と設定について詳しく見ていきましょう。 ### 操作 Data Storeインポートコマンドを使用して実行できる操作は3つあります。 * Insert: CSVファイルからテーブルにデータの新しい行を挿入します * Update: テーブル内の既存のデータ行を更新します * Upsert: 挿入と更新の両方の操作を同時に実行できます。レコードが既に存在する場合、行が更新されます。レコードが存在しない場合、データを含む新しい行が挿入されます。 入力JSON設定ファイルで実行する操作を指定できます。 ### 入力CSVファイル 前述の通り、インポート操作はCSVファイルからテーブルにレコードを一括書き込みします。CSVファイルは2つの方法で提供できます。 1. この操作の実行を開始する前に、レコードを含むCSVファイルをStratusのバケットにアップロードできます。この場合、コマンド実行時に渡すJSON設定ファイルに、Stratusでファイルに生成された一意のオブジェクトURLを指定する必要があります。 2. コマンドにJSON設定ファイルを渡さない場合は、上記の一般構文に示されているように、コマンド実行でシステム内のCSVファイルのパスを指定する必要があります。Catalystは指定されたCSVファイルをプロジェクトのバケットにアップロードし、実行用のオブジェクトURLを自動的に取得します。Stratusにファイルを保存するパスを選択できます。 Catalystは、JSONファイルで指定されたオブジェクトURLよりも、コマンドで指定されたCSVファイルを優先します。どちらにもCSVファイルが指定されていない場合、CLIはコマンド実行中にエラーメッセージを表示します。 注意: 1. CSVファイルの最初の行はヘッダー行でなければなりません。つまり、カラム名がヘッダー行として存在する必要があります。 2. CSVファイルはCSVファイル標準に準拠した形式でデータを含む必要があります。ファイルが標準形式でない場合、テーブルに書き込まれたデータが破損する可能性があります。 3. 開発環境では、プロジェクトごとに各テーブルに5000件のレコードを挿入できます。CSVファイルにそれ以上のレコードが含まれている場合、最初の5000件のレコードがテーブルに書き込まれます。開発環境ではその他のレコードはスキップされます。本番環境ではデータ挿入の上限はありません。 <br> ### JSON設定ファイルの構造 インポート操作の要件を指定するサンプルJSON設定ファイルは、コマンド実行時にオプションで渡すことができ、以下に示されています。 { "table_identifier" : "ZylkerEmpDatabase", "operation" : "upsert", "object_url" : "https://bucket-name-development.zohostratus.com/object-name", "callback" : { "url" : "https://hr.zylker.com/ja/EmpRecords/_callback.php.com", "headers" : { "src" : "ZCatalyst", "operation" : "bulkwriteAPI" } }, "find_by" : "EmpID", "fk_mapping" : [ { "local_column" : "EmpID", "reference_column" : "EmployeeID" }, { "local_column" : "DeptID", "reference_column" : "DepartmentID" } ] } JSON設定ファイルでサポートされているパラメータは以下のように定義されています。 <table class="content-table"> <thead> <tr> <th class="w30p">属性</th> <th class="w70p">説明</th> </tr> </thead> <tbody> <tr> <td><strong>table_identifier</strong> <br> (String、必須) </td> <td>データをインポートするテーブルの一意のIDまたはテーブル名。-\-tableオプションを使用してテーブル識別子を渡すこともできます。</td> </tr> <tr> <td><strong>operation</strong><br> (String、任意)</td> <td>実行する操作を指定します。<br /> <br /> <strong>使用可能な値:</strong>insert、update、upsert<br /> <br /> <strong>デフォルト操作:</strong> insert</td> </tr> <tr> <td><strong>object_url</strong><br> (String、必須)</td> <td>Stratus内のCSVファイルの一意のID。<br> コマンドでCSVファイルパスを指定することもできます。</td> </tr> <tr> <td><strong>find_by</strong><br><br> (String、updateおよびupsert操作では必須。insert操作では不要)</td> <td>レコードを識別するために使用される一意のカラム。<br /> <br /> たとえば、「EmployeeID」という一意のカラムをfind_by値として指定した場合、CatalystはData Storeテーブル内のレコードを<em>EmployeeID</em>値を使用して検索します。更新操作では、CSVファイルの<em>EmployeeID</em>値に一致する行を更新します。Upsert操作では、既存の行を更新し、一致するEmployeeID値のレコードがない場合は新しい行を挿入します。<br /> <br /> <strong>Update:</strong> Data Storeで設定された一意の値を持つカラム、またはCatalystがレコードに生成したROWIDを使用できます。<br /> <br /> <strong>Upsert:</strong> Data Storeで設定された一意の値を持つカラムのみ指定できます。ROWIDをfind_by値として指定することはできません。これは、Upsertは一致するものが見つからない場合に新しい行を挿入しますが、Data Storeに存在しない行にはROWID値が利用できないためです。<br /> <br /> <strong>Insert:</strong> Insert操作にfind_byカラムを指定した場合、CSVファイルのカラム値に一致するレコードはスキップされ、Data Storeテーブルに挿入されません。これは、Insertは指定されたレコードが既に存在する場合に更新できないためです。</td> </tr> <tr> <td><strong>fk_mapping</strong><br> (JSON、任意)</td> <td>他のテーブルで主キーであるカラムの外部キーマッピング。CSVファイルからインポートされたカラムを外部キーとして設定する必要がある場合に指定します。<br /> <br /> 外部キーは以下の形式でマッピングする必要があります:<br> {<br> "local_column" :<br> "local_column_name_1",<br> "reference_column" : "reference_column_name_1"<br> }<br> <br> ここで、local_columnは一括書き込み操作が処理されるテーブルのカラム名、reference_columnは主キーであるテーブルのカラム名です。<br /> </td> </tr> <tr> <td><strong>callback</strong><br> (JSON、任意)</td> <td>ジョブステータスの自動JSONレスポンスが送信されるコールバックURLのプロパティを定義するセクション。このセクションに含めるプロパティは以下の表に記載されています。</td> </tr> </tbody> </table> #### コールバックプロパティ <table class="content-table"> <thead> <tr> <th class="w30p">属性</th> <th class="w70p">説明</th> </tr> </thead> <tbody> <tr> <td><strong>url</strong><br><br> (String、コールバックURLを指定する場合は必須)</td> <td>ジョブステータスが変更されるたびに、HTTP POSTメソッドを使用して自動レスポンスが送信されるURL。ジョブの詳細情報はJSONレスポンスの本文に含まれます。<br /><br /> CLIは実行のライブストリームと最終的なジョブステータスも表示します。</td> </tr> <tr> <td><strong>headers</strong><br> (String、任意) <td>コールバックURLへのJSONレスポンスで渡す必要があるヘッダー<br /> <br /> ヘッダーは以下のように指定する必要があります:<br> {<br> "{header_name_1}" : "{header_value_1}",<br> "{header_name_2}" : "{header_value_2}"<br> }<br> <br> 以下同様です。</td> </tr> <tr> <td><strong>params</strong><br> (String、任意)</td> <td>コールバックURLに追加する必要があるパラメータ<br /> <br /> パラメータは以下のように指定する必要があります:<br /> {<br> "{param_name_1}" : "{param_value_1}",<br> "{param_name_2}" : "{param_value_2}"<br> }<br> <br> 以下同様です。</td> </tr> </tbody> </table> 注意: JSONファイルで必須のCSVファイルパラメータとテーブル識別子パラメータを指定しない場合、またはコマンド実行時にJSONファイルを渡さない場合は、CSVファイルパスとテーブル識別子をインポートオプションとして指定する必要があります。 <br> ### インポートジョブの処理状態 インポート操作には3つのジョブ処理状態があります。 * 進行中: インポートコマンドを実行するとすぐにジョブがこの状態に入ります。CLIは job\_id パラメータを表示し、JSONにコールバックURLを設定していない場合は、これを使用して後続のレスポンスのジョブ実行ステータスを手動で確認できます。<br /> <br /> コールバックURLを設定している場合、定義した形式でjob\_idを含む状態レスポンスがURLにも送信されます。 * 成功: インポート操作が成功した場合、Catalystはジョブ実行の詳細を含むCSVレポートファイルをダウンロードできるダウンロードURLを提供します。Catalystでは、CLIを通じてレポートファイルをシステムに直接ダウンロードすることもできます。コールバックURLを設定している場合、このレスポンスもURLに送信されます。 * 失敗: インポート操作が失敗した場合、CLIは発生したエラーの詳細を表示します。コールバックURLを設定している場合、このレスポンスもURLに送信されます。 <br> ### インポートオプション インポートコマンドの実行プロセスは、各オプションについてこのセクションで詳しく説明されています。Data Storeインポートコマンドは以下のオプションをサポートしています。 <br> #### -\-config &lt;path&gt; configオプションを使用すると、システム内のJSON設定ファイルのパスを定義できます。<br /> <br /> たとえば、以下のようにインポート操作を実行してJSONファイルパスを渡すことができます。<br /> <br /> CLIは自動的にジョブの実行をスケジュールし、「進行中」としてマークします。 job_id とともに実行プロセスのライブストリームを表示します。<br /> <br /> ジョブが正常に実行された場合、CLIはレポートファイルをシステムにダウンロードするよう求めます。「y」と入力し、Enterを押してダウンロードします。<br /> <br /> レポートファイルを含むZIPファイルがプロジェクトディレクトリにダウンロードされます。<br /> <br /> Catalystが提供するダウンロードURLを使用して、CLIで作業していないときでもレポートをダウンロードできます。APIコマンドとして実行する必要があります。<br /> 注意: ダウンロードURLは生成後1日間有効です。 CSVレポートファイルには、書き込みがスキップされたすべてのレコードとその理由が一覧表示されます。<br /> <br> <br> #### -\-table &lt;name|id&gt; <br /> -\\-tableオプションを使用すると、レコードを書き込むテーブルのテーブル名またはテーブルIDを指定できます。<br /> <br /> 前述の通り、JSONファイルでテーブル識別子を指定しない場合、またはコマンド実行時にJSONファイルを渡さない場合は、このオプションを使用して指定する必要があります。<br /> <br /> Catalystは、JSONファイルで指定されたテーブルよりも、オプションで指定されたテーブルを優先します。どちらにもテーブルが指定されていない場合、CLIはコマンド実行中にエラーメッセージを表示します。<br /> <br /> たとえば、以下の方法でCSVファイルパスとともにテーブル識別子を指定できます。<br /> <br /> CSVファイルパスを指定した場合、CLIはインポート操作を実行し、指定されたテーブルにレコードを一括書き込みし、同じ方法でレポートファイルを提供します。<br /> 注意: バケットのパスは空にできません。 #### -\-production <br /> \--productionオプションを使用すると、Catalystプロジェクトの本番環境でインポート操作を直接実行できます。このオプションを使用すると、入力CSVファイルのレコードが本番環境の指定されたテーブルに直接一括書き込みされます。<br /> 注意: このオプションは、プロジェクトの本番環境がすでに有効になっている場合にのみ使用できます。 -------------------------------------------------------------------------------- title: "エクスポート操作" description: "Catalystでは、CLIを使用してData Store内のテーブルに対して一括読み取りおよび一括書き込み操作を実行できます。" last_updated: "2026-08-17T13:08:49.608Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/data-store-import-and-export/export-operation/" service: "All Services" -------------------------------------------------------------------------------- # Data Storeエクスポート ### はじめに Data Storeエクスポートコマンドの一般的な構文は以下の通りです。 catalyst ds:export [options] ### JSON設定ファイルの構造 Data Storeエクスポートコマンドは、入力JSON設定ファイルで定義した条件に一致する、指定したテーブルからレコードを取得します。コマンドにJSONファイルを渡さない場合、または条件を指定しない場合、デフォルトでテーブルのすべてのレコードが読み取られます。 エクスポート操作の要件を指定するサンプルJSON設定ファイルは、コマンド実行時にオプションで渡すことができ、以下に示されています。 JSON設定ファイルでサポートされているパラメータは以下のように定義されています。 <table class="content-table"> <thead> <tr> <th class="w30p">属性</th> <th class="w70p">説明</th> </tr> </thead> <tbody> <tr> <td><strong>table_identifier</strong><br> (String、必須)</td> <td>データをエクスポートするテーブルの一意のIDまたはテーブル名。--tableオプションを使用してテーブル識別子を渡すこともできます。</td> </tr> <tr> <th><strong>query</strong><br> (JSON、任意)</th> <th>エクスポートジョブの条件と基準を定義するセクション</th> </tr> <tr> <td><strong>page</strong><br> (Numerical、任意)</td> <td>一括読み取りプロセスの結果として生成されるCSVファイルには、1ページに20万件のレコードが含まれます。<br /> <br /> ページ値「1」は、クエリに一致する最初の20万件のレコードがエクスポートされることを示します。ページ値を増やすことで、後続のレコードを取得できます。<br /> <br /> たとえば、200,001件目から400,000件目のレコードを取得する場合は、ページ値を「2」と指定する必要があります。<br /> <br /> デフォルト値: 1<br><br> --pageオプションを使用してページ値を指定することもできます。</td> </tr> <tr> <td><strong>select_columns</strong><br> (Array、任意)</td> <td>テーブルから取得する必要があるレコードの特定のカラム。カラムを指定しない場合、すべてのカラムが選択されて取得されます。<br /> <br /> 配列に複数のカラムを含めることができます。</td> </tr> <tr> <th><strong>callback</strong><br> (JSON、任意)</th> <th>ジョブステータスの自動JSONレスポンスが送信されるコールバックURLのプロパティを定義するセクション</th> </tr> <tr> <td><strong>url</strong><br> (String、コールバックURLを指定する場合は必須)</td> <td>ジョブステータスが変更されるたびに、HTTP POSTメソッドを使用して自動レスポンスが送信されるURL。ジョブの詳細情報はJSONレスポンスの本文に含まれます。<br /> <br /> CLIは実行のライブストリームと最終的なジョブステータスも表示します。</td> </tr> <tr> <td><strong>headers</strong><br> (String、任意)</td> <td>コールバックURLへのJSONレスポンスで渡す必要があるヘッダー<br /> <br /> ヘッダーは以下のように指定する必要があります:<br> {<br> "{header_name_1}" : "{header_value_1}",<br> "{header_name_2}" : "{header_value_2}"<br> }<br> <br /> 以下同様です。</td> </tr> <tr> <td><strong>params</strong><br> (String、任意)</td> <td>コールバックURLに追加する必要があるパラメータ<br /> <br /> パラメータは以下のように指定する必要があります:<br> {<br> "{param_name_1}" : "{param_value_1}",<br> "{param_name_2}" : "{param_value_2}"<br> }<br> <br /> 以下同様です。</td> </tr> <tr> <th><strong>criteria</strong><br> (JSON、任意)</th> <th>レコードが取得される条件のセット。このセクションに含めるプロパティは以下の表に記載されています。</th> </tr> </tbody> </table> <br> #### 条件プロパティ <table class="content-table"> <thead> <tr> <th class="w30p">属性</th> <th class="w70p">説明</th> </tr> </thead> <tbody> <tr> <td><strong>group_operator</strong><br> (String、条件を指定する場合は必須)</td> <td>条件グループを結合する演算子。<br /> <br /> サポートされている演算子: AND、OR<br /> <br /> 2つ以上の条件グループを定義する場合、ANDまたはOR演算子を使用できます。たとえば、「column1 equal value 1 AND column2 contains value 2」のような条件を、前のセクションで指定された形式で指定できます。<br /> <br /> 注意: 両方の演算子の組み合わせは使用できません。1回のコマンド実行ではANDまたはORのいずれかのみ使用できます。</td> </tr> <tr> <td><strong>group</strong><br> (JSON、条件を指定する場合は必須)</td> <td>このセクションには最大25個の条件セットを含めることができます。サンプルJSONファイルには2つの条件セットが示されています。<br /> <br /> <strong>注意:</strong> 1回の実行では、1つのグループ演算子を持つ1つの全体グループのみ含めることができます。</td> </tr> <tr> <td><strong>column_name</strong><br> (String、条件を指定する場合は必須)</td> <td>条件を定義するテーブルの特定のカラム名</td> </tr> <tr> <td><strong>comparator</strong><br> (String、条件を指定する場合は必須)</td> <td>カラム名と条件値を照合する比較演算子<br /> <br /> <strong>サポートされている比較演算子:</strong> equal、not_equal、greater_than、greater_equal、less_than、less_equal、starts_with、ends_with、contains、not_contains、in、not_in、between、not_between<br /> <br /> 注意:<br> * inおよびnot_in比較演算子には、カンマで区切って複数の値を指定できます。 * Catalystは暗号化されたカラムに対してequal比較演算子のみサポートしています。暗号化されたカラムの条件として他の比較演算子は使用できません。</td> </tr> <tr> <td><strong>value</strong><br> (String、条件を指定する場合は必須)</td> <td>条件として定義するレコード内の特定カラムの値</td> </tr> </tbody> </table> 注意: JSONファイルで必須のテーブル識別子パラメータを指定しない場合、またはコマンド実行時にJSONファイルを渡さない場合は、エクスポートオプションを使用して指定する必要があります。 ### エクスポートジョブの処理状態 エクスポート操作には3つのジョブ処理状態があります。 * 進行中: インポートコマンドを実行するとすぐにジョブがこの状態に入ります。CLIはjob_id パラメータを表示し、JSONにコールバックURLを設定していない場合は、これを使用して後続のレスポンスのジョブ実行ステータスを手動で確認できます。<br /> <br /> コールバックURLを設定している場合、定義した形式でjob_idを含む状態レスポンスがURLにも送信されます。 * 成功: エクスポート操作が成功した場合、Catalystはクエリに一致するレコードを含むCSVファイルをダウンロードできるダウンロードURLを提供します。Catalystでは、CLIを通じて結果ファイルをシステムに直接ダウンロードすることもできます。コールバックURLを設定している場合、このレスポンスもURLに送信されます。 * 失敗: エクスポート操作が失敗した場合、CLIは発生したエラーの詳細を表示します。コールバックURLを設定している場合、このレスポンスもURLに送信されます。 ### エクスポートオプション エクスポートコマンドの実行プロセスは、各オプションについてこのセクションで詳しく説明されています。Data Storeエクスポートコマンドは以下のオプションをサポートしています。 <br> #### -\-config &lt;path&gt; \--configオプションを使用すると、システム内のJSON設定ファイルのパスを定義できます。 たとえば、以下のようにエクスポート操作を実行してJSONファイルパスを渡すことができます。 CLIは自動的にジョブの実行をスケジュールし、「進行中」としてマークします。 job_idとともに実行プロセスのライブストリームを表示します。 <br> <br> ジョブが正常に実行された場合、CLIは結果ファイルをシステムにダウンロードするよう求めます。「y」と入力し、Enterを押してダウンロードします。 <br> 結果ファイルを含むZIPファイルがプロジェクトディレクトリにダウンロードされます。 <br> Catalystが提供するダウンロードURLを使用して、CLIで作業していないときでも結果ファイルをダウンロードできます。APIコマンドとして実行する必要があります。 注意: ダウンロードURLは生成後1日間有効です。 <br> CSV結果ファイルには、エクスポートジョブクエリに一致するすべてのレコードの一覧が含まれます。 <br> <br> #### -\-table &lt;name|id&gt; <br /> -\\-tableオプションを使用すると、レコードを読み取るテーブルのテーブル名またはテーブルIDを指定できます。 前述の通り、JSONファイルでテーブル識別子を指定しない場合、またはコマンド実行時にJSONファイルを渡さない場合は、このオプションを使用して指定する必要があります。 Catalystは、JSONファイルで指定されたテーブルよりも、オプションで指定されたテーブルを優先します。どちらにもテーブルが指定されていない場合、CLIはコマンド実行中にエラーメッセージを表示します。 たとえば、以下の方法でテーブル識別子を指定できます。 catalyst ds:export --table EmpDetails CLIはエクスポート操作を実行し、指定されたテーブルからレコードを一括読み取りし、同じ方法で結果を提供します。 <br> <br> #### -\-page &lt;page&gt; JSONパラメータのセクションで説明したように、テーブルから取得するレコードの範囲を示すページ値を指定できます。 たとえば、以下のコマンドを実行して200,001件目から400,000件目のレコードを取得できます。 catalyst ds:export --page 2 <br> <br> #### -\-production -\\-productionオプションを使用すると、Catalystプロジェクトの本番環境でエクスポート操作を直接実行できます。このオプションを使用すると、本番環境のテーブルからレコードが一括読み取りされます。 注意: このオプションは、プロジェクトの本番環境がすでに有効になっている場合にのみ使用できます。 -------------------------------------------------------------------------------- title: "インポート/エクスポートステータスの確認" description: "Catalystでは、CLIを使用してData Store内のテーブルに対して一括読み取りおよび一括書き込み操作を実行できます。" last_updated: "2026-08-17T13:08:49.608Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/data-store-import-and-export/check-import-export-status/" service: "All Services" -------------------------------------------------------------------------------- # インポートまたはエクスポート操作のステータス確認 ### はじめに 以前に開始したData Storeのインポートまたはエクスポート操作のステータスを、必要なときにいつでも手動で確認できます。 JSONファイルにコールバックURLを設定していなかった場合や、CLIのインポートまたはエクスポートコマンドの実行を終了した場合は、このコマンドを使用してジョブのステータスを確認できます。CLIは、インポートまたはエクスポートジョブが進行中か、正常に実行されたか、失敗したかを通知します。 このコマンドでは、操作を開始したときにインポートまたはエクスポートジョブに割り当てられた job_id を使用する必要があります。 <br> ### ステータス確認コマンド インポートまたはエクスポートジョブのステータス確認コマンドの一般的な構文は以下の通りです。 ds:status [options] &lt;operation&gt; [job_id] &lt;operation&gt;の値はimportまたはexportのいずれかである必要があり、必ず指定する必要があります。job\_idはオプションです。job\_idを指定しない場合、過去24時間以内に実行された指定操作のすべてのジョブが一覧表示されます。 たとえば、job\_idを指定せずにエクスポート操作を指定した場合、CLIは以下のようにすべてのエクスポートジョブの一覧を表示します。 一覧から特定のジョブIDを選択してEnterを押すと、その詳細なステータスを表示できます。 CLIは、前のセクションで説明したように、ジョブが正常に実行された場合にダウンロードURLを提供し、レスポンスファイルのダウンロードを可能にするのと同じプロセスに従います。 コマンドにjob\_idを指定した場合、CLIは直接そのジョブのステータスを取得して表示します。 <br> ### -\-productionオプション インポート/エクスポートステータス確認コマンドは1つのオプションをサポートしています: -\\-production このオプションを使用すると、Catalystプロジェクトの本番環境で実行された操作のステータスを確認できます。インポートまたはエクスポートコマンドの実行で-\\-productionオプションを使用した場合は、ステータスの確認にもこのオプションを使用する必要があります。 注意: このオプションは、プロジェクトの本番環境がすでに有効になっている場合にのみ使用できます。 ### Functionの操作 -------------------------------------------------------------------------------- title: "はじめに" description: "Catalyst CLIを使用すると、プロジェクトの初期化後でもFunction コンポーネントのセットアップ、プロジェクトへの複数のFunctionの追加、メモリの設定、Node shellでのFunctionのテスト、およびFunctionの削除が可能です。" last_updated: "2026-08-17T13:08:49.609Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-functions/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Functionの操作 ### はじめに Catalyst CLIを使用すると、プロジェクトの初期化時にセットアップしなかったプロジェクトコンポーネントをセットアップして操作できます。プロジェクトの作業中にいつでもCLIからクライアントディレクトリやFunctionディレクトリをセットアップできます。 この機能は、プロジェクトの初期化時にFunctionパッケージを初期化しなかった場合や、空のプロジェクトを初期化した後にアプリケーションにFunctionコンポーネントを追加する必要がある場合に非常に便利です。Functionディレクトリを1つのFunctionでセットアップし、必要に応じて後から追加のFunctionを追加できます。Catalyst Functionの詳細については、Functionヘルプページをご覧ください。 Java、Node.js、またはPythonのFunctionが初期化またはセットアップされると、依存ファイルと設定ファイルがCatalystによって自動的にFunctionのフォルダに追加されます。そのため、Catalyst FunctionはCLIまたはCatalystコンソールを使用して作成することをお勧めします。これにより、依存ファイルのボイラープレートコードが標準プロジェクトディレクトリ構造に適切に追加されます。Functionコンポーネントの更新情報は、セットアップ時に catalyst.json ファイルにも追加されます。 また、コーディング後にCLIからCatalyst Functionをローカルでテスト、実行、デバッグするためのnode shellを起動することもできます。CLIでは、デプロイ済みのFunctionを削除することもできます。これらのCLIコマンドについては、このヘルプドキュメントで説明します。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalyst Functionを操作する手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "Functionのセットアップ" description: "Catalyst CLIを使用すると、プロジェクトの初期化後でもFunctionコンポーネントのセットアップ、プロジェクトへの複数のFunctionの追加、メモリの設定、Node shellでのFunctionのテスト、およびFunctionの削除が可能です。" last_updated: "2026-08-17T13:08:49.609Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-functions/set-up-functions/" service: "All Services" -------------------------------------------------------------------------------- # Functionのセットアップ ### Functionタイプのセットアップ 1. プロジェクトディレクトリに移動し、CLIで以下のコマンドを実行して、プロジェクトにFunctionディレクトリをセットアップできます： catalyst functions:setup <br /> 手順はプロジェクト初期化時のFunctionディレクトリの初期化と同じです。 2. 開発したいFunctionのタイプを選択し、Enterを押します。<br /> <br /> Catalystで開発できる6種類のFunctionは、Basic I/O、Advanced I/O、Event、Cron、Browser Logic、Integration、およびBrowser Logic Functionです。Functionのタイプとその目的の詳細については、 **Functionヘルプページ** をご参照ください。 <br> **Integration Function:** <br> Integration Function以外のすべてのFunctionタイプでは、CLIの初期化プロセスは同じです。リストから_Integration_を選択した場合、次のステップに進む前に以下の2つの追加ステップを実行する必要があります：<br><br> i. 統合するサービスを選択します。現在はCliq統合のみ選択できます。<br /> ii. 必要なハンドラを選択します。詳細については、Integration Functionヘルプページをご参照ください。<br /> 残りのセットアッププロセスはすべてのFunctionタイプで同じです。プロセスはFunctionスタックによってのみ異なります。 注意: Cliq Integration Functionは現在、EU、AU、IN、またはCAデータセンターからアクセスするCatalystユーザーには利用できません。ConvoKraft Integration Functionはすべてのデータセンターからアクセスするユーザーが利用可能です。 <br> 3. サーバーサイドFunctionを開発するスタックを選択し、Enterを押します。リストにはサポートされているすべてのランタイムが表示されます。リストからJava、Node.js、またはPythonの最新サポートランタイムを選択できます。<br /> 注意: catalyst functions:add コマンドを使用して、単一のFunctionディレクトリにJava、Node.js、またはPythonのFunctionを含めることができます。 <br> ### 任意のタイプのJava Functionのセットアップ 1. Java Functionをセットアップする場合、サポートされているランタイムから必要なものを選択します：**Java 8**、**Java 11**、**Java 17**、**Java 21**、**Java 25**。 <br> 注意: Java Functionスタックのバージョンを選択する前に、システムに関連するJDKがインストールされていることを確認してください。以下のリンクから関連するJDKをインストールすることもできます： * Java 8 * Java 11 * Java 17 * Java 21 * Java 25 2. プロンプトが表示されたらJava Functionの参照名を入力して**Enter**を押し、Java Functionのメインクラス名を入力して**Enter**を押します。CLIはJava SDKパッケージをダウンロードし、Functionのセットアッププロセスを完了します。 <br> 3. **Java 11**、**Java 17**、**Java 21**、または**Java 25**のFunctionを初めて初期化またはセットアップする場合、システムにインストールされているJDKのパス情報を追加で設定する必要があります。この情報は、ローカルシステムに隠しファイルとして存在する特定の設定ファイルに設定できます。インストールされたJDKのパスは、config:set &lt;key=value&gt; CLIコマンドを使用して設定する必要があります。このコマンドの詳細については、こちらのヘルプドキュメントをご参照ください。 設定ファイルにパス情報を以下の例のように設定します： **Java 11**： catalyst config:set java11.bin=/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin <br /> **Java 17**： catalyst config:set java17.bin=/Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home/bin <br /> **Java 21**： catalyst config:set java21.bin=/Library/Java/JavaVirtualMachines/jdk-21.jdk/Contents/Home/bin <br /> **Java 25**： catalyst config:set java25.bin=/Library/Java/JavaVirtualMachines/jdk-25.jdk/Contents/Home/bin <br /> 注意: * 上記のコマンドに記載されているパスをお使いのJDKパスに置き換えてください。 * ローカルシステムがWindows OSで動作している場合は、パスをダブルクォーテーションで囲んでください。たとえば、Java 11のパスを以下のように設定します：<br /> catalyst config:set java11.bin="/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin" <br /> Java Functionのフォルダには、メインの.javaクラスファイル、ライブラリJARファイル、catalyst-config.json、およびその他の設定ファイルが作成されます。これらの値はcatalyst.json設定ファイルに更新されます。 <br> <br /> Java Functionのディレクトリ構造の詳細については、プロジェクトディレクトリ構造ヘルプページをご参照ください。<br /> ### 任意のタイプのNode.js Functionのセットアップ 1. Node.js Functionをセットアップする場合、サポートされているランタイムから必要なものを選択します：**Node 24**、**Node 22**、**Node 20**、**Node 18**、**Node 16**、**Node 14**、**Node 12**。 <br> 2. プロンプトが表示されたらNode Functionのパッケージ名を入力し、Enterを押します。<br /> 3. エントリポイントファイルの名前を入力し、Enterを押します。<br /> 4. Function作成者の名前を入力し、Enterを押します。<br /> 5. CLIがnode依存関係のインストールを許可するよう求めます。Yを押してインストールを確認し、Enterを押して選択を確定します。必要な依存関係をすべてインストールしないと、Function実行時にエラーが発生する可能性があります。<br /> <br /> CLIはNode.js SDKパッケージをダウンロードし、Functionのセットアッププロセスを完了します。<br /> 注意: Catalystでは、Expressテンプレートを使用してAdvanced I/O Node.js Functionを作成でき、Express.jsモジュールがインストールされます。ただし、CLIからExpressテンプレートを作成することはできません。特定のFunctionのディレクトリから npm install express --save を実行して、システムにExpressを独立してインストールし、そのFunctionでExpressモジュールを使用できます。Expressテンプレートの詳細については、Advanced I/O Functionヘルプページをご参照ください。 <br> Node Functionのディレクトリは、.jsメインFunctionファイル、catalyst-config.json、および依存関係をインストールした場合は必要なnodeモジュールと設定ファイルでセットアップされます。これらの値はcatalyst.json設定ファイルに更新されます。<br /> <br /> Node.js Functionのディレクトリ構造の詳細については、プロジェクトディレクトリ構造ヘルプページをご参照ください。 ### 任意のタイプのPython Functionのセットアップ 1. Python Functionをセットアップする場合、サポートされているランタイムから必要なものを選択します：**Python 3.9**、**Python 3.10**、**Python 3.11**、**Python 3.12**、または**Python 3.13**。 2. プロンプトが表示されたらPython Functionのパッケージ名を入力し、Enterを押します。 3. エントリポイントファイルの名前を入力し、Enterを押します。 Python Functionの初期化が成功すると、Catalyst Python SDKパッケージがプロジェクトに自動的にインストールされ、requirements.txtファイルにエントリが追加されます。 注意: Python Functionを初めて初期化する場合、システムにインストールされているPythonのパス情報を追加で設定する必要があります。この情報は、ローカルシステムに隠しファイルとして存在する特定の設定ファイルに設定できます。パスはconfig:set &lt;key=value&gt; CLIコマンドを使用して設定する必要があります。このコマンドの詳細については、こちらのヘルプドキュメントをご参照ください。 Python Functionのディレクトリは、.pyメインFunctionファイル、catalyst-config.json、およびrequirements.txt設定ファイルでセットアップされます。これらの値はcatalyst.json設定ファイルに更新されます。 <br /> Python Functionのディレクトリ構造の詳細については、プロジェクトディレクトリ構造ヘルプページをご参照ください。 注意: * Java、Node.js、またはPythonのFunctionディレクトリには、任意の数のサブフォルダとファイルを追加できます。メインFunctionファイルの他に、Functionのフォルダにはその他のサブFunctionを含めることができます。ただし、設定ファイルと依存関係はFunctionディレクトリのルートに配置する必要があります。 * Node.js Functionのサブfunctionは、Catalystコンソールまたは外部エディタを使用して作成できます。ただし、JavaおよびPythonのFunctionはCLIからのみ作成および更新できます。 * catalyst pullコマンドを使用して、コンソールから既存のFunctionディレクトリをローカルシステムにプルすることもできます。 セットアップしたFunctionで作業を開始できます。パッケージをCatalystコンソールにアップロードしてコンソールのオンラインエディタを使用してコーディングするか、お好みのエディタを使用できます。また、functions shellを使用してFunctionのコードをテスト・実行し、コンソールにデプロイすることもできます。 -------------------------------------------------------------------------------- title: "Functionの追加" description: "Catalyst CLIを使用すると、プロジェクトの初期化後でもFunctionコンポーネントのセットアップ、プロジェクトへの複数のFunctionの追加、メモリの設定、Node shellでのFunctionのテスト、およびFunctionの削除が可能です。" last_updated: "2026-08-17T13:08:49.610Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-functions/add-functions/" service: "All Services" -------------------------------------------------------------------------------- # Functionの追加 プロジェクトの最初のFunctionを初期化またはセットアップした後、Functionディレクトリに任意の数のJava、Node.js、PythonスタックのFunctionを追加できます。各新しいFunctionは、Functionディレクトリ内に独自のディレクトリとして作成されます。 注意: このコマンドは、最初のFunctionが作成された後にプロジェクトに追加のFunctionを追加するために使用します。そのため、このコマンドを実行する前に、プロジェクトディレクトリにFunctionディレクトリが既に存在している必要があります。 <br> プロジェクトディレクトリから以下のコマンドを実行して、Functionディレクトリに新しいFunctionを追加できます： catalyst functions:add <br> 手順はFunctionの初期化またはセットアップと同じです。詳細については、前のセクションをご参照ください。 Functionが追加されると、前のセクションで説明したように、Functionディレクトリ内にその依存関係と設定ファイルとともに個別のフォルダが作成されます。 <br /> 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalyst Functionを追加する手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "Functionメモリの設定" description: "Catalyst CLIを使用すると、プロジェクトの初期化後でもFunctionコンポーネントのセットアップ、プロジェクトへの複数のFunctionの追加、メモリの設定、Node shellでのFunctionのテスト、およびFunctionの削除が可能です。" last_updated: "2026-08-17T13:08:49.610Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-functions/configure-function-memory/" service: "All Services" -------------------------------------------------------------------------------- # Functionメモリの設定 ### 設定コマンド Catalystでは、各Functionのメモリを設定できます。このメモリはFunctionの実行時に割り当てられます。任意のFunctionに対して128 MBから512 MBの間でメモリを選択できます。 Functionに割り当てられるデフォルトのメモリは256 MBです。つまり、メモリを設定しない場合、またはこの機能が利用可能になる前にFunctionを作成した場合、メモリは自動的に256 MBに設定されます。 注意: CPUは、Functionに設定したメモリに基づいて自動的に割り当てられます。この値を表示または設定することはできません。 既存のFunctionのこの値を、要件に応じて以下の方法で変更できます： 1. Functionのプロジェクトディレクトリから以下のコマンドを実行します。 catalyst functions:config CLIは、プロジェクトで作成したすべてのFunctionを、現在のメモリ割り当て情報とともに一覧表示します。 2. 設定するFunctionを1つ選択し、Enterを押します。<br /> 3. 利用可能なオプションからFunctionに割り当てるメモリを選択し、Enterを押します。<br /> Functionのメモリ設定が更新されます。<br /> <br> 以下のように、コマンドとともにFunctionの名前またはIDを指定して、Functionのメモリを直接設定することもできます： catalyst functions:config[function_name_or_id] たとえば： catalyst functions:config Generate_Invoice CLIは同じ方法でメモリ設定の選択を求めます。 ### Functionメモリ設定オプション catalyst functions:configコマンドの<br> -\\-memory &lt;value&gt; オプションを使用し、Functionの名前またはIDを続けて指定することで、特定のFunctionに割り当てるメモリを直接指定することもできます。 これは以下の方法で行えます： catalyst functions:config [--memory &lt;value&gt;] [function_name_or_id] <br> たとえば、_MailOrder_という名前のFunctionに128 MBのメモリを割り当てたい場合は、以下のコマンドを実行します： catalyst functions:config --memory 128MB MailOrder CLIが確認を求めます。Yを入力してEnterを押します。 Functionのメモリ設定が更新されます。 -------------------------------------------------------------------------------- title: "Functionのシェル起動" description: "Catalyst CLIを使用すると、プロジェクトの初期化後でもFunctionコンポーネントのセットアップ、プロジェクトへの複数のFunctionの追加、メモリの設定、Node shellでのFunctionのテスト、およびFunctionの削除が可能です。" last_updated: "2026-08-17T13:08:49.610Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-functions/functions-shell/" service: "All Services" -------------------------------------------------------------------------------- # Functionのシェル起動 ### はじめに functions shellは、Node shellコンソールの機能とCatalyst CLIの効率性を組み合わせて、Functionのテストとデバッグを行う機能を提供します。 Catalyst CLI functions shellを使用すると、プロジェクト内のJava、Node.js、またはPythonプラットフォームの以下のFunctionタイプをテストおよびデバッグできます：Basic I/O、Cron、Event、およびIntegration Function。 注意: node shellを使用してAdvanced I/O Functionをテストすることはできません。ただし、catalyst serveコマンドを使用して、Advanced I/O Function、Basic I/O Function、およびクライアントをローカルホストからサーブしてパフォーマンスをテストできます。 Functionの実行出力はJSON形式でCLIに取得・表示されます。Basic I/O Functionの場合はCLIに文字列出力が生成され、その他のFunctionタイプの場合は適切なレスポンスが取得されます。 JavaまたはNode.jsスタックのBasic I/O Functionをテストする際は、Functionのエンドポイントにデバッガをアタッチしてローカルサーバーを介してコードをテストしたり、シェルでHTTPモードを有効にしたりすることもできます。Python Functionではこの機能はサポートされていませんが、Python Functionを独立してデバッグすることは可能です。 Catalyst CLIはfunctions shellのその他のオプションも提供しており、このセクションの後半で説明します。 <br> ### Functions Shellコマンドの実行 Functionをテストするためのシェルを起動するには、Functionのプロジェクトディレクトリに移動し、以下のコマンドを実行します： catalyst functions:shell これによりCLIでシェルが開きます。Advanced I/O Function以外のプロジェクト内の任意のFunctionをテストし、Basic I/O Functionの場合は入力を渡して実行し、その他のnode shell操作を実行できます。 シェルでBasic I/O Functionに入力を渡す方法は2つあります： * Function変数に値を渡してFunctionを実行する。 * CLIで変数を宣言し、Function変数に代入して、宣言した変数を介して入力値を渡す。その後、宣言した変数をそのFunctionにバインドして実行できます。 #### 直接入力を渡す例 _EMI_というシンプルなFunctionをテストしましょう。このFunctionでは、_principal_という変数に入力値を渡すことができます。このFunctionは、いくつかの事前定義された定数値に基づいて、配送サービスのEMI金額を計算します。 シェルで以下のステートメントを入力して、入力変数の値を渡し_EMI_ Functionを実行します： EMI({"principal":"10000"}) これにより_EMI_ Functionが呼び出され、入力がその変数に渡されます。Functionの実行が完了すると、サーバーからJSONレスポンスとして出力が取得されます。CLIは、サーバーから送信されたHTTPステータスコードとともにFunctionの出力を表示します。 #### 変数を宣言してバインドする例 CLIで変数を宣言し、Function内の変数に代入することもできます。これにより、宣言した変数をFunctionの変数の代わりに使用して、入力値を簡単に渡すことができます。 変数'P'を宣言し、_EMI_ Functionの_principal_変数に代入して入力値を渡しましょう。シェルで以下のコマンドを実行します： var P={"principal":"3000"} これにより_P_が_principal_に代入され、Pに入力値3000が渡されます。コンソールでPの値を出力して、変数が代入されているか確認できます。 これはNode.jsのconsole.log() functionを以下の方法で使用して行えます： console.log(P) 変数が代入され値が正常に渡された場合、シェルは渡された_principal_の値を出力します。 宣言した変数をFunctionにバインドして、以下のように実行できます： EMI(P) これによりFunctionが呼び出され、_P_を介してその変数に入力が渡されます。Functionの実行が完了すると、CLIはサーバーから送信されたHTTPステータスコードとともに出力を表示します。 ランタイムエラーが発生した場合、CLIはサーバーから適切なHTTPレスポンスコードを返します。 #### シェルの終了 ローカル環境に応じてターミナルコマンドを終了するか、以下のコマンドを実行してfunctions shellを終了できます： .exit Functionのテストが十分に完了したら、ローカル環境からリモートコンソールにFunctionをデプロイできます。 ### Functions Shellオプション functions shellの起動コマンドで使用できるオプションは4つあります。 #### \--http \[port\] -\\-httpオプションは、Basic I/O FunctionをHTTPモードで呼び出します。CLIはローカルホストを介してFunctionをサーブし、ローカルエンドポイントへのアクセスを提供します。サーバーはFunctionがローカルでホストされているポートをリッスンし、CLIはそのポートでのアクティビティのライブログを表示します。その後、CLIはfunctions shellを開き、Functionをテストできます。 注意: -\\-httpオプションはBasic I/O Functionにのみ適用されます。Cron、Event、およびIntegration Functionのエンドポイントには直接アクセスできないためです。 このオプションは、Basic I/O Function、Advanced I/O Function、およびクライアントコンポーネントをローカルでサーブする catalyst serve コマンドの機能と同様です。 プロジェクトディレクトリから以下のコマンドを実行して、HTTPモードでfunction shellを起動し、プロジェクト内のすべてのBasic I/O Functionをテストできます： catalyst functions:shell --http これにより、プロジェクトのFunctionディレクトリ内のすべてのBasic I/O Functionがデフォルトポート8080でローカルにホストされます。CLIはすべてのFunctionのエンドポイントURLを表示します。シェル操作の実行中はいつでも、ブラウザでURLを開いてこれらのFunctionにアクセスできます。 前のセクションで説明したようにシェルを使用してFunctionのテストと実行を行い、URLにアクセスしてHTTPモードで表示できます。 必要に応じて、このコマンドの実行時にデフォルトポート8080をオーバーライドして別のポートでサーバーを起動することもできます。-\\-httpオプションでポート番号を指定して行います。 たとえば、ポート7000を使用したい場合は、プロジェクトディレクトリから以下のコマンドを実行します： catalyst serve --http 7000 #### \--debug \[port\] Catalystでは、ライブlocalhostサーバーにリモートデバッガをアタッチして、JavaおよびNode.js Functionをローカルでテストできます。 注意: catalyst functions:shell --debugコマンドはPython Functionではサポートされていません。Python Functionのデバッグ手順については、こちらのセクションをご参照ください。 -\\-debugオプションを使用してfunctions shellを起動すると、Catalystはデフォルトまたはカスタムポートでトランスポートdt\_socketをリッスンし、Functionの呼び出し後にデバッガからの接続が確立されるのを待ちます。接続が確立されると、アタッチされたデバッガがFunctionの実行をデバッグし、コード内のエラーや問題を特定します。 プロジェクトディレクトリから以下のコマンドを実行して、functions shellを起動しデバッガへの接続を開始できます： catalyst functions:shell --debug これにより、以前と同じ方法でfunctions shellが開きます。シェルでFunctionを呼び出すと、Catalystがデバッガへの接続を確立します。Catalyst CLIはデフォルトでデバッガにポート8000を割り当てます。 デバッガがアタッチされると、CLIはそのことを示すメッセージを表示します。その後、CatalystはデバッグモードでFunctionを実行し、サーバーレスポンスを表示します。 必要に応じて、デフォルトポート8000をオーバーライドして別のポートでデバッガを起動できます。-\\-debugオプションでポート番号を指定して行います。 たとえば、ポート7000を使用したい場合は、プロジェクトディレクトリから以下のコマンドを実行します： catalyst serve --debug 7000 #### \--ignore-scripts このオプションを使用すると、特定のFunctionの catalyst.json ファイルに記述されたライフサイクル前後のスクリプトを無視するようCatalystに指示できます。 functions shellの-\\-httpオプションを使用してBasic I/O Functionのエンドポイントをホストしてアクセスできるため、ホスト時にpreserveおよびpostserveスクリプトが自動的に実行されます。preserveスクリプトはFunctionがサーブされる前に実行され、postserveスクリプトはローカルサーブを終了した後に実行されます（利用可能な場合）。 -\\-ignore-scriptsオプションを使用して、Functionがサーブされる際にこれらのライフサイクル前後のスクリプトを無視するようCatalystに指示できます。 たとえば、プロジェクトのcatalyst.jsonファイルに、Functionの以下のpreserveおよびpostserveスクリプトを含めるように設定しましょう。 \--ignore-scriptsオプションを使用せずにfunctions shellを起動すると、以下に示すように、シェルが開く前とシェルを終了した後にそれぞれスクリプトが実行されます。 preserveおよびpostserveスクリプトを無視するには、プロジェクトディレクトリから以下のコマンドを実行してfunctions shellを起動します： catalyst functions:shell --ignore-scripts これによりスクリプトが無視され、標準的な方法でシェルが実行されます。 #### \--no-watch Catalyst CLIはデフォルトでfunctions shellにライブウォッチモードを有効にしています。このモードは、シェルが開かれた後にFunctionファイルまたはFunctionディレクトリで行われた変更を能動的に監視します。Functionファイルまたはディレクトリで変更がコミットされたことを検出すると、functions shellのホットリロードを有効にして更新をライブで反映します。そのため、変更を保存した直後に、コードの再コンパイルや再サーブを行うことなく、ライブシェルでFunctionの更新バージョンにアクセスできます。 以下のように-\\-no-watchオプションを使用してfunctions shellを起動することで、このデフォルトのウォッチモードを無効にできます： catalyst functions:shell --no-watch シェルで起動した後にFunctionファイルに変更を加えても、シェルで開いているコンパイル済みFunctionには更新が反映されません。変更後にFunctionを再呼び出しするか、シェルを終了して再度開くことで、Functionの更新バージョンを操作できます。 たとえば、Node.js Basic I/O Functionのデフォルトサンプルコードを含むFunctionを考えましょう。functions shellで呼び出すと「Hello from index.js」というメッセージが出力されます。 以下のようにFunctionのコードを変更しても、Functionがまだシェルで開いている間はCLIにライブで更新が反映されません。 更新されたコードの出力を取得するには、Functionを再度呼び出す必要があります。 ただし、-\\-no-watchオプションを使用せずにデフォルトのウォッチモードを有効にしたままfunctions shellを起動すると、シェルはコードの変更をライブで検出し、以下に示すようにFunctionのホットリロードを自動的に実行します。 <br> ### Python Functionのデバッグ Python Functionをデバッグするには、Catalystは現在CLIでのデバッグをサポートしていないため、Python IDEを独立して使用する必要があります。Visual Studio CodeやPyCharmなど、お好みのIDEでローカルデバッガをアタッチできます。デバッガはFunctionがローカルでホストされているポートをリッスンし、IDEはそのポートでのアクティビティのライブログを表示します。 VS Codeを使用してPython Functionをデバッグする手順は以下の通りです： 1. IDEからローカルサーバーでホストされている特定のPython Functionをデバッグするには、ローカルサーバーとIDEの間の接続を確立するデバッガパッケージが必要です。この場合、debugpy Pythonパッケージを使用します。 VS CodeでCatalystプロジェクトディレクトリを開きます。main.pyファイルに、以下のコード行を追加します。 import debugpy debugpy.listen(<<"Enter port number here">>) debugpy.wait_for_client() 注意: VS Codeデバッグ設定のアタッチ用デフォルトポートは5678です。これはPython Functionがサーブされるポートです。必要に応じて、以下のオプションを使用してserveコマンドの実行時にデフォルトポートをオーバーライドして変更できます： catalyst serve --http &lt;Port number&gt; 2. Functionディレクトリに移動し、debugpyパッケージをインストールするために、IDEターミナルで以下のコマンドを実行します： python -m pip install --upgrade debugpy 3. Catalystプロジェクトのルートディレクトリにlaunch.jsonファイルがまだ存在しない場合は作成します。launch.jsonファイルの作成手順については、こちらのヘルプページをご参照ください。ファイルに以下のコードを追加して保存します。 { "version": "0.2.0", "configurations": [ { "name": "Python: Remote Attach", "type": "python", "request": "attach", "connect": { "host": "localhost", "port": <<Enter port number here>> }, "pathMappings": [ { "localRoot": "${workspaceFolder}", "remoteRoot": "${workspaceFolder}/.build/" } ], "justMyCode": true } ] } 4. VS Codeで「実行とデバッグ」ビューに切り替え、デバッガを開始します。IDEターミナルでCLI serveコマンドを実行して、Functionの実行詳細を確認できます。 注意: コマンドの実行時に、設定ファイルに記載されたものと同じポート番号を指定するようにしてください。 VS CodeでのPython Functionのローカルスクリプトデバッグのより詳細な手順については、こちらのヘルプページをご参照ください。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalyst Functionを実行およびデバッグする手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "Functionの削除" description: "Catalyst CLIを使用すると、プロジェクトの初期化後でもFunctionコンポーネントのセットアップ、プロジェクトへの複数のFunctionの追加、メモリの設定、Node shellでのFunctionのテスト、およびFunctionの削除が可能です。" last_updated: "2026-08-17T13:08:49.611Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-functions/delete-functions/" service: "All Services" -------------------------------------------------------------------------------- # Functionの削除 ### 削除コマンドの実行 CLIを使用して、CatalystプロジェクトのFunctionを完全に削除できます。このコマンドの実行時に、リモートコンソールまたはローカルプロジェクトディレクトリからFunctionを削除することを選択できます。 注意: Functionが両方の場所に存在する場合、選択した場所からのみ削除されます。たとえば、リモートコンソールからFunctionを削除しても、ローカルマシンから別途削除するまで、ローカルプロジェクトディレクトリには引き続き存在します。 <br> 1. プロジェクト内のFunctionを削除するには、プロジェクトディレクトリから以下のコマンドを実行します： catalyst functions:delete <br> 2. CLIがリモートコンソールのFunctionとローカルプロジェクトディレクトリのFunctionのどちらかを選択するよう求めます。オプションを選択してEnterを押します。<br /> <br> 3. 選択したオプションに基づいて、CLIはリモートコンソールまたはローカルディレクトリ内のすべてのFunctionを一覧表示します。削除するFunctionを選択してEnterを押します。<br /> <br> 4. CLIが確認を求めます。「Y」を入力してEnterを押して確認します。選択したFunctionが選択した場所から削除されます。<br /> <br> 注意: 同期が必要な場合は、 catalyst pull コマンドを使用してリモートコンソールからローカルディレクトリにリソースをプルするか、 catalyst deploy を使用してローカルディレクトリからリモートコンソールにリソースをデプロイできます。 <br> 以下のように、コマンドとともにFunctionの名前またはIDを含めて、削除するFunctionを直接指定することもできます： catalyst functions:delete [function_name_or_id] たとえば： catalyst functions:delete InvoiceFetch CLIは同じ方法で、リモートコンソールとローカルディレクトリのどちらかを選択するよう求め、その後削除の確認を求めます。 注意: リモートコンソールからFunctionを削除するには、Function名またはIDを直接指定できます。ただし、ローカルディレクトリからFunctionを削除するには、IDではなくFunction名のみを指定する必要があります。 <br> ### Function削除オプション それぞれのオプションを使用して、リモートコンソールまたはローカルプロジェクトディレクトリのFunctionを直接一覧表示して削除することを選択できます。 ローカルプロジェクトディレクトリで利用可能なFunctionを一覧表示するには、catalyst functions:deleteコマンドを以下のように実行します： catalyst functions:delete --local プロジェクトのリモートコンソールで利用可能なFunctionを一覧表示するには、catalyst functions:deleteコマンドを以下のように実行します： catalyst functions:delete --remote CLIはそれに応じてFunctionを一覧表示し、前述のように必要なFunctionを削除できます。 以下のように、リモートコンソールまたはローカルディレクトリからFunctionを直接削除することもできます： catalyst functions:delete InvoiceFetch --remote <br /> 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalyst Functionを削除する手順はこちらをご覧ください。 ### Slateの操作 -------------------------------------------------------------------------------- title: "Slateアプリの作成" description: "Catalyst CLIを使用すると、プロジェクトディレクトリ内のアプリケーションにSlateアプリの設定を作成できます。" last_updated: "2026-08-17T13:08:49.611Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-slate/create-slate-app/" service: "All Services" -------------------------------------------------------------------------------- # Slateの操作 # 追加のSlateアプリの作成 プロジェクトディレクトリが既にCatalystプロジェクトにリンクされており、Slateが初期化されている場合、以下の手順でプロジェクトディレクトリに新しいSlateアプリを直接追加できます。この操作により、選択したフロントエンドフレームワークに基づくSlateテンプレートコードがプロジェクトディレクトリに自動的に追加されます。 1. Slateサービスのプロジェクトディレクトリからターミナルで以下のコマンドを実行します： catalyst slate:create 2. Slateアプリケーションに必要なフレームワークを選択し、アプリケーションの名前を入力します。 3. 選択したフレームワークに基づいて、**install**コマンドと**build**コマンド、フレームワークの**ビルドパス**が自動的に検出されます。デフォルトの設定で続行する場合は**N**を入力します。必要な更新を行う場合は**Y**を入力します。 すべての変更が完了すると、Slateアプリがプロジェクトディレクトリに作成されます。 **catalyst.json**ファイルが、新しく作成されたSlateアプリの詳細で更新されます。 アプリケーションの名前と必要なフレームワークを直接指定して、Slateアプリケーションを作成することもできます。ターミナルで以下のコマンドを実行します： catalyst slate:create --name &lt;name&gt; --framework &lt;framework_name&gt; -------------------------------------------------------------------------------- title: "Slateアプリのリンク" description: "Catalyst CLIを使用すると、既存のアプリケーションにSlate設定をリンクして、Slateにデプロイできます。" last_updated: "2026-08-17T13:08:49.611Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-slate/link-slate-app/" service: "All Services" -------------------------------------------------------------------------------- # Slateアプリのリンク 既存のプロジェクトをSlateにデプロイするには、プロジェクトのルートパスをSlateサービスにリンクする必要があります。そのためには、まずSlateサービスを初期化する必要があります。このリンクにより、プロジェクトディレクトリとSlateサービスの間にローカルで接続が確立されます。コンソールにデプロイするには、deployコマンドを使用する必要があります。 このオプションは、Slateがサポートするフレームワークのアプリケーションが元々Slateサービスとして初期化されていなかったが、後からSlateサービスとしてデプロイしたい場合に使用できます。 ディレクトリをSlateにリンクするには、以下の手順に従ってください。 1. アプリのプロジェクトディレクトリからターミナルで以下のコマンドを実行します： catalyst slate:link Slateサービスにリンクするソースパスを選択し、**Enter**を押します。 2. 必要に応じてアプリケーションの名前を入力し、**Enter**を押します。 3. アプリケーションのフレームワークが自動的に検出され、**install**コマンド、**build**コマンド、および**ビルドパス**とともに表示されます。検出されない場合は、ターミナルからフレームワークを手動で選択できます。 デフォルトの設定で続行する場合は**N**を入力します。必要な更新を行う場合は**Y**を入力します。 設定が完了すると、プロジェクトディレクトリのパスとSlateサービスの間の接続を確立するためのエントリがcatalyst.jsonファイルに追加されます。 -------------------------------------------------------------------------------- title: "Slateアプリのリンク解除" description: "Catalyst CLIを使用すると、不要になった場合に既存のアプリケーションからSlate設定のリンクを解除できます。" last_updated: "2026-08-17T13:08:49.611Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-slate/unlink-slate-app/" service: "All Services" -------------------------------------------------------------------------------- # Slateアプリのリンク解除 以下の手順を使用して、プロジェクトディレクトリとSlateサービス間の接続を削除できます。この操作は、アプリケーションを既にデプロイしている場合でも、プロジェクトディレクトリ内のSlate設定のみを削除し、Catalystコンソール内の設定は削除しません。 1. アプリのプロジェクトディレクトリからターミナルで以下のコマンドを実行します： catalyst slate:unlink 2. 矢印キーを使用してアプリケーションを選択し、**Enter**をクリックして確認します。 3. **Yes**を入力すると、アプリケーションからSlate設定、catalyst.jsonファイルのエントリ、およびアプリケーションのソースコードが削除されます。**No**を入力すると、アプリケーションのソースコードを保持したまま、catalyst.jsonファイルのエントリのみが削除されます。 同じ操作を、アプリケーション名を直接指定して以下のコマンドでも実行できます： catalyst slate:unlink --name &lt;&lt;app_name&gt;&gt; ### イベント生成 -------------------------------------------------------------------------------- title: "はじめに" description: "Catalystでは、CLIを使用してCatalyst Event Listenersがサポートするさまざまなイベントソースからサンプルペイロードを生成できます。" last_updated: "2026-08-17T13:08:49.611Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/event-generate/introduction/" service: "All Services" -------------------------------------------------------------------------------- # イベント生成 ### はじめに Catalystでは、CLIを使用してCatalyst SignalsのCatalyst Publishersに関連するイベントのサンプルペイロードを生成できます。 catalyst event:generateコマンドは、CLIでCatalyst Publishersのサンプルペイロードを生成します。ペイロードが必要な特定のPublisherとアクションを指定できます。生成されたペイロードを使用して、ローカル環境からプロジェクト内のEvent Functionsをテストできます。 Event Functionsに加えて、プロジェクト内のIntegration Functionsのサンプルペイロードを生成してテストすることもできます。catalyst event:generate:integコマンドを使用すると、インテグレーションサービス、コンポーネントソース、およびハンドラーを選択してペイロードを生成できます。 その後、CLIからNodeシェルを起動して、生成されたサンプルペイロードデータをFunctionに渡すことで、EventまたはIntegration Functionをテストおよびデバッグできます。 注意: * CLIの両方のイベント生成コマンドは、ローカル環境でFunctionsをテストするためのサンプルペイロードを生成するだけです。これらのアクションは、Signals、Functions、またはプロジェクトやリモートコンソールで設定したコンポーネントには反映されません。それらは影響を受けません。 * Cliq Integration Functionsは、EU、AU、IN、またはCAデータセンターからアクセスするCatalystユーザーには現在利用できません。ConvoKraft Integration Functionsはすべてのデータセンターからアクセスするユーザーが利用できます。 * Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してEvent、Cron、Integration Functionsをデバッグする手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "コンポーネントイベントのサンプルペイロード" description: "Catalystでは、CLIを使用してCatalyst Event Listenersがサポートするさまざまなイベントソースからサンプルペイロードを生成できます。" last_updated: "2026-08-17T13:08:49.611Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/event-generate/sample-payload-component-event/" service: "All Services" -------------------------------------------------------------------------------- # コンポーネントイベントソースのサンプルペイロード生成 注意: * Event Listenersコンポーネントは現在非推奨となっています。より新しく堅牢なイベントバスサービスであるCatalyst Signalsへの移行を強くお勧めします。Catalyst Signalsの詳細はこちら。 * Catalyst Publishersをソースとするイベントのペイロード生成について学ぶ。 ### ペイロード生成 コンポーネントイベントリスナーは、Catalystコンポーネントの1つで発生する特定のイベントをリッスンし、関連するターゲットFunctionをトリガーしてコンポーネントデータを渡します。プロジェクトにはデフォルトで作成されています。CLIで、必要なソースとアクションの同じパターンのサンプルデータを取得できます。 CLIでイベントのサンプルペイロードを生成する一般的なコマンドは次のとおりです： catalyst event:generate|generate:event [options] &lt;source&gt; &lt;action&gt; <br> 以下の表に示すCatalystコンポーネントイベントのソースと関連するアクションの任意の組み合わせをコマンドに指定できます： <table class="content-table"> <thead> <tr> <th class="w30p"><strong>ソース</strong></th> <th class="w30p"><strong>アクション</strong></th> <th class="w40p"><strong>オプション入力</strong></th> </tr> </thead> <tbody> <tr> <td><span class="badge">datastore</span></td> <td><span class="badge">Insert</span> <span class="badge">Update</span> <span class="badge">Delete</span></td> <td><span class="badge">--table &lt;table_name_or_id&gt;</span></td> </tr> <tr> <td><span class="badge">cache</span></td> <td><span class="badge">Put</span></td> <td><span class="badge">--segment &lt;segment_name_or_id&gt;</span></td> </tr> <tr> <td><span class="badge">user</span></td> <td><span class="badge">SignUp</span> <span class="badge">Delete</span></td> <td>NA</td> </tr> <tr> <td><span class="badge">webapp</span></td> <td><span class="badge">Success</span></td> <td>NA</td> </tr> <tr> <td><span class="badge">github</span></td> <td><span class="badge">Success</span> <span class="badge">Failure</span></td> <td>NA</td> </tr> </tbody> </table> <br> たとえば、Data Store Insertイベントのサンプルペイロードを生成するには、次のコマンドを実行します： catalyst event:generate|generate:event datastore Insert <br> これにより、このソースとアクションの次のJSONペイロードが生成されます。ペイロードには、プロジェクトの実際の詳細、デフォルトのイベントバスの詳細、およびサンプルエンティティの詳細が含まれます。 このデータをFunctionsシェルを通じてEvent Functionに渡し、要件に応じてテストできます。 <br> CLIに表示する代わりに、次のようにJSONペイロードを直接ファイルに保存することもできます： catalyst event:generate|generate:event user Signup>>payload.json <br> ### オプション入力 必須のソースとアクションのペアに加えて、表に示すようにエンティティソースに関するオプション入力を提供することもできます。たとえば、Data Storeのinsert操作のサンプルペイロード生成時にテーブル名またはIDを指定すると、Catalystはリモートプロジェクトでその名前またはIDのテーブルを確認します。エンティティが存在する場合、CLIはJSONペイロードにそのテーブルのデータを表示します。 オプション入力を提供しない場合、または入力に一致するエンティティが見つからない場合、CLIはランダムなサンプルデータでJSONペイロードを生成します。 <br> たとえば、リモートコンソールで設定された既存のセグメントでのcache putイベントのサンプルペイロードを生成するには、次のコマンドを実行します： catalyst event:generate|generate:event cache Put --segment &lt;segment_name_or_id&gt; <br> Catalystはその名前またはIDのセグメントを確認します。存在する場合、そのセグメントのデータを含むペイロードが生成されます。渡されたSegment IDは、以下の例でsource\_entity\_idの値として指定されています。 <br /> ### コンポーネントイベント生成オプション catalyst event:generateコマンドは、一緒に使用できる2つのオプションをサポートしています。ただし、コンポーネントイベントソースのサンプルペイロードを生成する場合、それらのオプションのうち1つのみが適用されます。 <br> #### -e | -\-event-bus <event\_bus\_name> -\\-event-busまたは\-eオプションを使用すると、サンプルペイロードで使用するイベントバスの名前を指定できます。任意のソースまたはアクションのペイロード生成時にこれを使用できます。event\_bus\_details JSONには、渡された名前がバス名として含まれます。 イベントバス名を指定しない場合、コンポーネントイベントのペイロードではバス名は「Default」になります。 <br> たとえば、cache putイベントのペイロードを生成し、イベントバス名を指定するには、次のコマンドを実行します： catalyst event:generate|generate:event cache Put --event-bus TrackerRequests <br> これにより、ペイロードが生成され、event\_bus\_detailsにイベントバス名が含まれます。 利用可能なオプションについては、次のセクションでカスタムイベントソースのコンテキストで説明します。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してEvent Functionsをデバッグする手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "カスタムイベントのサンプルペイロード" description: "Catalystでは、CLIを使用してCatalyst Event Listenersがサポートするさまざまなイベントソースからサンプルペイロードを生成できます。" last_updated: "2026-08-17T13:08:49.612Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/event-generate/sample-payload-custom-event/" service: "All Services" -------------------------------------------------------------------------------- # カスタムイベントソースのサンプルペイロード生成 注意: * Event Listenersコンポーネントは現在非推奨となっています。より新しく堅牢なイベントバスサービスであるCatalyst Signalsへの移行を強くお勧めします。Catalyst Signalsの詳細はこちら。 * Catalyst Publishersをソースとするイベントのペイロード生成について学ぶ。 ### ペイロード生成 カスタムイベントリスナーは、エンドユーザーがそのURLを呼び出すたびにターゲットFunctionにデータを渡すために使用されます。カスタムイベントリスナーには複数のルールを含めることができ、異なるターゲットFunctionsに関連付けることができます。カスタムイベントリスナーのすべてのルールは同じURLエンドポイントを持ちますが、各ルールには作成時に設定できる一意のルール識別子変数が含まれます。これにより、呼び出す特定のルールを示すことができます。 注意: カスタムイベントリスナーはデフォルトではプロジェクトに存在しません。そのため、サンプルペイロードを生成するには、まずリモートコンソールからプロジェクトにカスタムイベントリスナーを作成する必要があります。ただし、この目的のためにルールを作成する必要はありません。サンプルペイロードの生成時にCLIでテスト目的のルールを作成できます。これはコンソールで設定されたカスタムイベントリスナーには反映されません。 <br> 同じコマンドを実行してカスタムイベントのサンプルペイロードを生成できます： catalyst event:generate|generate:event [options] &lt;source&gt; &lt;action&gt; <br> ただし、Catalystはカスタムイベントソースに対して以下のソースとアクションの値のみを受け付けます： <table class="content-table"> <thead> <tr> <th><strong>ソース</strong></th> <th><strong>アクション</strong></th> </tr> </thead> <tbody> <tr> <td><span class="badge">custom</span></td> <td><span class="badge">Produce</span></td> </tr> </tbody> </table> <br> ### 必須コマンドオプション カスタムイベントのサンプルペイロードを生成する際には、以下のオプションを必須で使用する必要があります： <br> #### -e | -\-event-bus <event\_bus\_name> \--event-busオプションは、前のセクションで説明したのと同じ機能を実行します。サンプルペイロードで使用するイベントバスの名前を指定できます。event\_bus\_details JSONには、渡された名前がバス名として含まれます。 <br> #### -rid | -\-rule-id <rule\_identifier> \--rule-idオプションを使用すると、カスタムイベントペイロードで使用するルール識別子を指定できます。前述のとおり、ルール識別子はカスタムイベントバス内のルールを一意に識別します。JSONのdataフィールドにルール識別子が含まれます。 カスタムイベントのサンプルペイロードを生成し、イベントバス名とルール識別子を渡すには、次のコマンドを実行します： catalyst event:generate|generate:event custom Produce --event-bus TrackerRequests --rule-id DomesticTracking <br> これにより、次のJSONペイロードが生成されます。ペイロードには、プロジェクトの詳細、指定したイベントバスとルール識別子の詳細、およびその他のサンプルデータが含まれます。 <br /> 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してEvent Functionsをデバッグする手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "Integration Functionsのサンプルペイロード" description: "Catalystでは、CLIを使用してCatalyst Event Listenersがサポートするさまざまなイベントソースからサンプルペイロードを生成できます。" last_updated: "2026-08-17T13:08:49.612Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/event-generate/sample-payload-integration-functions/" service: "All Services" -------------------------------------------------------------------------------- # Integration Functionsテスト用のサンプルペイロード生成 ### ペイロード生成 Integration Functionsを使用すると、Catalyst Functionを他のZohoサービスのバックエンドとしてコーディングおよび使用し、それらとのインテグレーションを確立できます。Catalystは現在、Integration Functionsを通じてZoho CliqおよびConvoKraft Bot Logicとのインテグレーションをサポートしています。 ボット、コマンド、メッセージアクション、ウィジェット、およびFunctionsをバンドルするCliq拡張機能のバックエンドをIntegration Functionsを通じて開発できます。CLIを使用すると、これらの各ツールのさまざまなハンドラーのサンプルペイロードを生成できます。 注意: Cliq Integration Functionsは、EU、AU、IN、またはCAデータセンターからアクセスするCatalystユーザーには現在利用できません。ConvoKraft Integration Functionsはすべてのデータセンターからアクセスするユーザーが利用できます。 <br> CLIでIntegration Functionをテストするためのサンプルペイロードを生成する一般的なコマンドは次のとおりです： catalyst event:generate:integ [options] &lt;service&gt; Catalystは現在Cliqとのインテグレーションのみをサポートしているため、サービスとして次の値を指定する必要があります： ZohoCliq 。 <br> Catalystは、CLIでサンプルペイロードを生成できる以下のCliqコンポーネントとハンドラークラスをサポートしています。 <table class="content-table"> <thead> <tr> <th>コンポーネント</th> <th>ハンドラークラス</th> </tr> </thead> <tbody> <tr> <td><span class="badge">bot</span></td> <td><span class="badge">welcome_handler</span><br><span class="badge">message_handler</span> <br><span class="badge">context_handler</span> <br><span class="badge">mention_handler</span><br><span class="badge">action_handler</span><br> <span class="badge">incomingwebhook_handler</span><br> <span class="badge">participation_handler</span></td> </tr> <tr> <td><span class="badge">command</span></td> <td><span class="badge">execution_handler</span> <br><span class="badge">suggestion_handler</span></td> </tr> <tr> <td><span class="badge">messageaction</span></td> <td><span class="badge">execution_handler</span></td> </tr> <tr> <td><span class="badge">widget</span></td> <td><span class="badge">view_handler</span></td> </tr> <tr> <td><span class="badge">function</span></td> <td><span class="badge">button_handler</span> <br><span class="badge">form_handler</span> <br><span class="badge">form_change_handler</span> <br><span class="badge">form_values_handler</span> <br><span class="badge">widget_button_handler</span></td> </tr> <tr> <td><span class="badge">installation</span></td> <td><span class="badge">installation_handler installation_validator</span></td> </tr> </tbody> </table> <br> 1. ペイロードを生成するコンポーネントとハンドラークラスを選択するには、次のコマンドを実行します： catalyst event:generate:integ ZohoCliq <br> 2. リストからコンポーネントを選択し、Enterキーを押します。<br /> <br> 3. リストからハンドラークラスを選択し、Enterキーを押します。<br /> <br> CLIは、そのコンポーネントとハンドラーソースのサンプルJSONペイロードを生成します。コンポーネントに応じて、ペイロードには関連するデータが含まれます。 CLIに表示する代わりに、JSONペイロードを直接ファイルに保存することもできます。 <br> ### Integration Functionsイベント生成オプション <br> #### \--inputs &lt;inputs&gt; コンポーネントと必要なデータのハンドラーを直接指定して、Integration Functionsをテストするためのサンプルペイロードを生成できます。入力は次の形式で指定する必要があります： catalyst event:generate:integ ZohoCliq --inputs component,handler <br> たとえば、functionコンポーネントのform\_handlerクラスのサンプルペイロードを生成するには、次のコマンドを実行します： catalyst event:generate:integ ZohoCliq --inputs function,form_handler <br> これにより、次のJSONペイロードが生成されます。 Catalystがサポートするcliqコンポーネントとハンドラークラスのリストについては、上記の表を参照してください。<br /> 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してEvent Functionsをデバッグする手順はこちらをご覧ください。 ### トークンの操作 -------------------------------------------------------------------------------- title: "はじめに" description: "Catalystは、アクティブにログインしていない場合にCLIコマンドの実行を認証するために使用できるトークンを提供します。" last_updated: "2026-08-17T13:08:49.612Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-tokens/introduction/" service: "All Services" -------------------------------------------------------------------------------- # トークンの操作 ### はじめに Catalyst CLIは、CLIセッションを特定のユーザーアカウントに関連付けて検証するトークンを提供します。CLIにログインしている場合、実行するコマンドは内部的にトークンによって認証されます。ただし、トークンを手動で生成し、アクティブなログインセッションなしですべてのCLIアクティビティを実行するために使用することもできます。 トークンは、CLIに独自にログインする必要がない継続的インテグレーションシステムなどのリモートシステムからCatalyst CLIにアクセスする場合に非常に便利です。生成したCLIトークンを使用して、CIシステムにCatalystへのアクセス認証を提供し、CLIコマンドをリモートで実行できます。 CLIトークンは、CLIからユーザーアカウントにログインしている場合にのみ生成できます。生成後は、アクティブなログインセッションがなくても、任意のデバイスからそのトークンを使用してCLI操作をリモートで実行できます。このトークンはそのユーザーアカウントの認証要素として機能し、指定したプロジェクトへのコマンド実行のマッピングを継続します。 また、Catalystプロジェクトのコラボレーターに特定のユーザーアカウントのトークンを提供して、ユーザーログイン資格情報を提供することなくCLI操作を実行できるようにすることもできます。 トークンが生成されると、そのトークンを識別するための一意のIDが作成されます。トークンを取り消す際には、このトークンIDを使用する必要があります。 トークンを使用する際は、以下の重要な点に留意してください： * トークンはCLIからのみ生成でき、CLIターミナルでのみ使用できます。CLI環境外ではトークンを操作できません。 * 特定のデバイスのターミナルでトークンを生成した場合、そのトークンは同じターミナルからのみ取り消すことができます。別のデバイスのターミナルからは取り消すことができません。ただし、そのトークンを使用して任意のデバイスや環境からCLI操作を実行できます。 * トークンは、生成時のユーザーアカウントのデータセンターに関連付けられます。そのため、コマンド実行にトークンを使用すると、同じデータセンターからCatalystにアクセスされます。 * Catalyst CLIで生成されたトークンは永久に有効です。個人的に取り消さない限り、期限切れにはなりません。 * ユーザーアカウントに複数のトークンを作成し、任意のデバイスからいつでもそれらのトークンを使用できます。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEで認証トークンを管理する手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "トークンの生成" description: "Catalystは、アクティブにログインしていない場合にCLIコマンドの実行を認証するために使用できるトークンを提供します。" last_updated: "2026-08-17T13:08:49.612Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-tokens/generate-token/" service: "All Services" -------------------------------------------------------------------------------- # トークンの生成 ### コマンドの実行 <br> 1. 以下のコマンドを実行して、Catalyst CLIからユーザーアカウントのトークンを生成できます： catalyst token:generate これによりトークン生成プロセスが開始されます。CLIは、任意のデバイスからアクセスできるURLを表示します。また、そのURLのWebページに入力する必要があるデバイス検証コードも生成されます。 <br> 2. CLIに表示されたURLに移動し、検証コードを入力します。Verifyをクリックします。コードは5分間のみ有効です。 <br> デバイスのCLIが検証されると、トークンが生成されCLIに表示されます。 <br> これで、ログアウトしている場合でも、以下の方法でCLIコマンドにオプションとしてトークンを指定することで、任意のリモートデバイスからCLI操作を実行できます： catalyst command --token [token] 詳細については、CLIオプションヘルプページをご参照ください。 CLI操作は、トークンを生成したユーザーアカウントにマッピングされ、そのディレクトリでアクティブなアカウントのプロジェクトに対してコマンドが実行されます。 <br> ### トークン生成オプション catalyst token:generateコマンドを使用して、ログインセッションで現在アクティブなトークンを確認することもできます。これを行うには、以下の方法で-\\-currentオプションを付けてコマンドを実行します： catalyst token:generate --current これにより、CLIで現在アクティブで認証されているトークンが表示されます。 注意: catalyst token:generate --currentコマンドは、CLIでユーザーアカウントにログインしている場合にのみ使用できます。 -------------------------------------------------------------------------------- title: "トークンの一覧表示" description: "Catalystは、アクティブにログインしていない場合にCLIコマンドの実行を認証するために使用できるトークンを提供します。" last_updated: "2026-08-17T13:08:49.612Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-tokens/list-tokens/" service: "All Services" -------------------------------------------------------------------------------- # トークンの一覧表示 ユーザーアカウントで利用可能なトークンの一覧を表示するには、CLIで以下のコマンドを実行します： catalyst token:list <br> これにより、そのアカウント用に生成したトークンの一覧が、トークンID、作成日時などの詳細とともに表示されます。 -------------------------------------------------------------------------------- title: "トークンの取り消し" description: "Catalystは、アクティブにログインしていない場合にCLIコマンドの実行を認証するために使用できるトークンを提供します。" last_updated: "2026-08-17T13:08:49.612Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-tokens/revoke-token/" service: "All Services" -------------------------------------------------------------------------------- # トークンの取り消し 同じCLIで以前に生成したトークンを取り消すことができます。これによりトークンは完全に削除され、CLI操作の認証に使用することはできなくなります。 トークンを取り消すには、トークンの生成に使用したのと同じデバイスのターミナルで以下のコマンドを実行します： catalyst token:revoke &lt;token ID&gt; 取り消すトークンのトークンIDを指定する必要があります。トークンのIDは、前のセクションで説明したコマンドを使用して確認できます。 ### クライアントの操作 -------------------------------------------------------------------------------- title: "はじめに" description: "Catalyst CLIを使用すると、プロジェクトの初期化後でもクライアントコンポーネントをBasic、React、またはAngularアプリとしてセットアップできます。" last_updated: "2026-08-17T13:08:49.626Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-the-client/introduction/" service: "All Services" -------------------------------------------------------------------------------- # クライアントの操作 ### はじめに Catalyst CLIを使用すると、プロジェクトの初期化時にセットアップしなかったプロジェクトコンポーネントをセットアップして操作できます。プロジェクトの作業中にいつでもCLIからクライアントディレクトリやFunctionディレクトリをセットアップできます。また、いつでも新しいAppSailサービスを追加できます。 この機能は、Webクライアントホスティングを通じてホストするためにプロジェクトの初期化時にクライアントパッケージを初期化しなかった場合や、空のプロジェクトを初期化した後にアプリケーションにクライアントコンポーネントを追加する必要がある場合に非常に便利です。このような場合、プロジェクトディレクトリ内の標準ディレクトリ構造でクライアントを素早くセットアップできます。 CLIは、クライアントの必要なすべての設定ファイルがボイラープレート構造で初期化されることを保証します。新しく作成されたクライアントコンポーネントの更新情報は、セットアップ時に catalyst.json ファイルにも自動的に追加されます。また、CLIからクライアントコンポーネントのリモート削除操作を実行し、以前にホストされたバージョンを削除することもできます。 注意: * Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalystクライアントコンポーネントを操作する手順はこちらをご覧ください。 * Webクライアントホスティングは、基本的でシンプルなWebアプリケーションに適しています。Next.js、Angular、React、Vueなど、さまざまな人気のJavaScriptフレームワークでWebアプリケーションをシームレスにデプロイできる堅牢なフロントエンド開発サービスSlateもご利用いただけます。Slateは、GitHub、GitLab、またはBitbucketからの自動デプロイメントも提供し、その他の高度な機能も多数備えています。 -------------------------------------------------------------------------------- title: "クライアントのセットアップ" description: "Catalyst CLIを使用すると、プロジェクトの初期化後でもクライアントコンポーネントをBasic、React、またはAngularアプリとしてセットアップできます。" last_updated: "2026-08-17T13:08:49.636Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-the-client/set-up-client/" service: "All Services" -------------------------------------------------------------------------------- # クライアントのセットアップ プロジェクトディレクトリに移動し、以下のコマンドを実行して、CLIからクライアントコンポーネントをセットアップできます： catalyst client:setup <br> 手順はプロジェクト初期化時のクライアントディレクトリの初期化と同じです。CLIがプロジェクトのクライアントコンポーネントの名前を入力するよう求めます。名前を入力してEnterを押します。 <br> クライアントディレクトリがプロジェクトのディレクトリに作成され、catalyst.jsonファイルがその情報で更新されます。 <br> クライアントディレクトリには、index.html、main.css、main.jsファイル、およびclient-package.json設定ファイルがセットアップされます。クライアントのディレクトリ構造の詳細については、プロジェクトディレクトリ構造ヘルプページをご参照ください。 <br> 注意: * クライアントのディレクトリには、HTMLファイル、JavaScriptファイル、ロゴ画像などのサブフォルダやファイルを任意の数追加できます。ただし、設定ファイルと依存関係はクライアントディレクトリのルートに配置する必要があります。 * catalyst pull コマンドを使用して、コンソールからホストされたWebクライアントをローカルシステムにプルすることもできます。 クライアントコンポーネントをビルドしてテストした後、Catalystコンソールの _Webクライアントホスティング_ を通じてホストするか、CLIからリモートコンソールにクライアントをデプロイできます。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してクライアントコンポーネントをセットアップする手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "クライアントの削除" description: "Catalyst CLIを使用すると、プロジェクトの初期化後でもクライアントコンポーネントをBasic、React、またはAngularアプリとしてセットアップできます。" last_updated: "2026-08-17T13:08:49.636Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-the-client/delete-client/" service: "All Services" -------------------------------------------------------------------------------- # クライアントの削除 ### コマンドの実行 CLIを使用して、Catalystプロジェクトのクライアントコンポーネントのバージョンを完全に削除できます。このコマンドの実行時に、リモートコンソールまたはローカルプロジェクトディレクトリからクライアントを削除することを選択できます。また、Webクライアントホスティングを通じてコンソールからクライアントバージョンを削除することもできます。 注意: * 現在ライブのクライアントバージョンを削除することはできません。現在ライブでホストされていないバージョンのみ削除できます。 * クライアントバージョンが両方の場所に存在する場合、選択した場所からのみ削除されます。たとえば、リモートコンソールからクライアントバージョンを削除しても、ローカルマシンから別途削除するまで、ローカルプロジェクトディレクトリには引き続き存在します。 1. CLIからクライアントコンポーネントの古いバージョンを削除するには、プロジェクトディレクトリ構造から以下のコマンドを実行します： catalyst client:delete <br> 2. CLIがリモートコンソールのクライアントとローカルプロジェクトディレクトリのクライアントのどちらかを選択するよう求めます。オプションを選択してEnterを押します。<br /> <br> 3. CLIが以前にホストされたWebアプリケーションのすべてのバージョンを表示します。ライブバージョン以外のバージョンをリストから選択し、Enterを押します。<br /> 選択したバージョンが、選択した場所からCatalystプロジェクトより削除されます。 <br> 注意: 同期が必要な場合は、 catalyst pull コマンドを使用してリモートコンソールからローカルディレクトリにリソースをプルするか、 catalyst deploy を使用してローカルディレクトリからリモートコンソールにリソースをデプロイできます。 <br> 以下の方法で、削除するクライアントバージョンを直接指定することもできます： catalyst client:delete [client_version] たとえば： catalyst client:delete 1.0.0 CLIは同じ方法で、リモートコンソールとローカルディレクトリのどちらかを選択するよう求め、その後削除の確認を求めます。 <br> ### クライアント削除オプション それぞれのオプションを使用して、リモートコンソールまたはローカルプロジェクトディレクトリのクライアントバージョンを直接一覧表示して削除することを選択できます。 ローカルプロジェクトディレクトリで利用可能なクライアントバージョンを一覧表示するには、catalyst client:deleteコマンドを以下のように実行します： catalyst client:delete --local プロジェクトのリモートコンソールで利用可能なクライアントバージョンを一覧表示するには、catalyst client:deleteコマンドを以下のように実行します： catalyst client:delete --remote CLIはそれに応じてクライアントバージョンを一覧表示し、前述のように必要なバージョンを削除できます。 以下のように、リモートコンソールまたはローカルディレクトリからバージョンを直接削除することもできます： catalyst client:delete 1.0.0 --remote <br /> 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してクライアントコンポーネントをセットアップする手順はこちらをご覧ください。 ### コンテキスト依存ヘルプ -------------------------------------------------------------------------------- title: "はじめに" description: "Catalystは、CLIコマンドの実行中にエラーが発生した場合にコンテキスト依存ヘルプを提供します。" last_updated: "2026-08-17T13:08:49.637Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/context-sensitive-help/introduction/" service: "All Services" -------------------------------------------------------------------------------- # CLIコンテキスト依存ヘルプ ### はじめに Catalystは、CLIコマンドの実行中にエラーが発生した場合にコンテキスト依存ヘルプを提供します。たとえば、コマンドの使用中に予期しないエラーが発生した場合や、コマンド実行中にリソースの取得中にエラーが発生した場合、Catalystはそのエラーの特定のコンテキストに対するヘルプを提供します。 コンテキストヘルプには、ユーザーによるコマンドの目的や使用方法の理解、およびエラー発生の原因の把握が含まれます。Catalystは状況を動的に分析して、期待される結果が得られない原因を特定し、それに応じてカスタマイズされたヘルプを提供します。 コマンド実行中に予期しないエラーが発生した場合、Catalystはエラーの原因を特定するだけでなく、エラーを修正または防止するために実行できるアクションのヘルプも提供します。Catalystは、特定のコマンドまたはアクションのドキュメントへのヘルプリンクも表示します。ヘルプリンクのURLをブラウザで開くだけで、ヘルプドキュメントにアクセスできます。 <br> #### コンテキストヘルプの例 * catalyst client:delete \[options\] \[client\_version\]コマンドを実行してクライアントのライブバージョンを削除しようとすると、CLIは現在ライブのクライアントは削除できないことを通知します。また、削除操作を再試行する前に、別のバージョンをライブにするか、クライアントの新しいバージョンをデプロイすることを提案します。詳細な説明を含むCLIドキュメントの特定のセクションへのヘルプリンクも提供されます。<br /> <br> * Catalystリモートアカウントからログアウトした状態でCLIコマンドを実行すると、CLIはコマンド実行の認証ができなかったことを通知します。アカウントにログインするか、有効な認証トークンを使用してコマンドを実行することを提案し、ヘルプリンクを提供します。<br /> <br> * 必要な設定ファイルが欠落した状態でリソースをデプロイすると、CLIは特定の欠落ファイルについて通知し、ディレクトリにそのファイルを含めることを提案します。提供されたヘルプリンクからプロジェクトディレクトリ構造について確認し、エラーを修正できます。<br /> -------------------------------------------------------------------------------- title: "コマンド実行で発生する可能性のあるエラー" description: "Catalystは、CLIコマンドの実行中にエラーが発生した場合にコンテキスト依存ヘルプを提供します。" last_updated: "2026-08-17T13:08:49.637Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/context-sensitive-help/possible-errors/" service: "All Services" -------------------------------------------------------------------------------- # コマンド実行で発生する可能性のあるエラーの一覧 CLI操作中のコマンド実行で発生する可能性のある一般的なエラーと、それらを解決するために実行できるアクションを以下に示します。 <br> <div class="mobile-h-scroll"> <table class="content-table"> <thead> <tr> <th class="right">コマンド/コンポーネント</th> <th class="middle-right">エラー</th> <th class="middle-right">修正方法</th> </tr> </thead> <tbody> <tr> <td rowspan="7" class="left pos-re">認証</td> <td class="middle-right">トークンバスケットが空</td> <td class="middle-right">新しいトークンを生成</td> </tr> <tr> <td class="middle-right">トークンの取得失敗</td> <td class="middle-right">一覧から有効なトークンを使用</td> </tr> <tr> <td class="middle-right">CLIからログアウト済み</td> <td class="middle-right">CLIにログイン</td> </tr> <tr> <td class="middle-right">リフレッシュトークンまたはアクセストークンの取得失敗</td> <td class="middle-right">--no-localhostを使用してCLIにログイン</td> </tr> <tr> <td class="middle-right">トークンの生成失敗</td> <td class="middle-right">新しいトークンを生成</td> </tr> <tr> <td class="middle-right">--tokenオプションで無効なトークンが指定された</td> <td class="middle-right">オプションに有効なトークンを指定</td> </tr> <tr> <td class="middle-right">認証失敗</td> <td class="middle-right">--forceオプションで再ログイン</td> </tr> <tr> <td class="left pos-re">データセンター</td> <td class="middle-right">--dcオプションの入力値が無効</td> <td class="middle-right">有効な入力値を指定して再試行</td> </tr> <tr> <td rowspan="7" class="left pos-re">プロジェクト</td> <td class="middle-right">最初のCatalystプロジェクトが未作成</td> <td class="middle-right">新しいプロジェクトを作成</td> </tr> <tr> <td class="middle-right">-pオプションで指定されたプロジェクトが見つからない</td> <td class="middle-right">一覧から既存のプロジェクトを選択</td> </tr> <tr> <td class="middle-right">プロジェクトディレクトリにファイルが欠落</td> <td class="middle-right">プロジェクトを初期化するか、欠落しているコンポーネントをセットアップ</td> </tr> <tr> <td class="middle-right">プロジェクトディレクトリにリソースが見つからない</td> <td class="middle-right">プロジェクトを初期化するか、欠落しているコンポーネントをセットアップ</td> </tr> <tr> <td class="middle-right">リモートコンソールにプロジェクトが見つからない</td> <td class="middle-right">一覧から利用可能なプロジェクトを使用</td> </tr> <tr> <td class="middle-right">プロジェクトディレクトリ内のファイルが破損</td> <td class="middle-right">破損したファイルを削除し、プロジェクトを再度初期化</td> </tr> <tr> <td class="middle-right">リモートコンソールにアクティブプロジェクトが見つからない</td> <td class="middle-right">既存のアクティブプロジェクトを利用可能なプロジェクトに変更</td> </tr> <tr> <td rowspan="14" class="left pos-re">API Gateway</td> <td class="middle-right">APIG有効化失敗 - APIGスケジューラーが進行中</td> <td class="middle-right">スケジュールされたジョブのステータスを確認し、しばらくしてから再試行</td> </tr> <tr> <td class="middle-right">APIGレポートが見つからない</td> <td class="middle-right">CLIからAPIGルールをデプロイ</td> </tr> <tr> <td class="middle-right">APIG無効化失敗 - APIGスケジューラーが進行中</td> <td class="middle-right">スケジュールされたジョブのステータスを確認し、しばらくしてから再試行</td> </tr> <tr> <td class="middle-right">APIGルールファイルを読み取れない</td> <td class="middle-right">指定されたエラーを修正して再試行</td> </tr> <tr> <td class="middle-right">APIGルールファイルが欠落</td> <td class="middle-right">欠落しているファイルを作成するか、有効なファイル名を指定</td> </tr> <tr> <td class="middle-right">APIGルールに名前が欠落</td> <td class="middle-right">APIGルールに名前を指定</td> </tr> <tr> <td class="middle-right">APIGルール名の重複</td> <td class="middle-right">名前を変更するか、APIGルールを削除</td> </tr> <tr> <td class="middle-right">APIGルールに必須値が欠落</td> <td class="middle-right">指定された必須値をAPIGルールに追加</td> </tr> <tr> <td class="middle-right">APIGルールに重複値がある</td> <td class="middle-right">APIGルールを変更して競合を解決</td> </tr> <tr> <td class="middle-right">APIGルールに無効なクライアントが指定された</td> <td class="middle-right">クライアントの指定されたエラーを修正して再試行</td> </tr> <tr> <td class="middle-right">クライアントターゲットでAPIGルールを認証できない</td> <td class="middle-right">APIGルールから指定されたキーを削除</td> </tr> <tr> <td class="middle-right">APIGルールに無効な正規表現</td> <td class="middle-right">指定された正規表現のエラーを修正</td> </tr> <tr> <td class="middle-right">APIGルールに無効なパラメータ</td> <td class="middle-right">指定されたエラーを修正して続行</td> </tr> <tr> <td class="middle-right">APIGルールに無効なリクエストまたはターゲットURL</td> <td class="middle-right">APIGルールに有効なターゲットURLを指定</td> </tr> <tr> <td rowspan="3" class="left pos-re">Data Store</td> <td class="middle-right">エクスポート/インポート操作でテーブル識別子が欠落</td> <td class="middle-right">コマンドまたは設定ファイルにテーブル識別子を指定</td> </tr> <tr> <td class="middle-right">インポート操作でソースファイルが欠落</td> <td class="middle-right">コマンドでローカルマシンのCSVファイルのパスを指定するか</td> </tr> <tr> <td rowspan="8" class="left pos-re">クライアント</td> <td class="middle-right">ローカルマシンにWebクライアントが見つからない</td> <td class="middle-right">新しいWebクライアントを作成</td> </tr> <tr> <td class="middle-right">リモートコンソールにWebクライアントが見つからない</td> <td class="middle-right">CLIからWebクライアントをデプロイ</td> </tr> <tr> <td class="middle-right">削除するWebクライアントバージョンがローカルマシン/リモートコンソールに見つからない</td> <td class="middle-right">利用可能なバージョンの一覧からバージョンを削除 </td> </tr> <tr> <td class="middle-right">Webクライアントバージョンがライブのため削除できない</td> <td class="middle-right">ライブバージョンを別のバージョンに変更するか、Webクライアントの新しいバージョンをデプロイ</td> </tr> <tr> <td class="middle-right">削除時に--localと--remoteオプションを同時に使用できない</td> <td class="middle-right">一度にどちらか一方のオプションのみを使用</td> </tr> <tr> <td class="middle-right">クライアントファイルを解析できない</td> <td class="middle-right">指定されたエラーを修正して再試行</td> </tr> <tr> <td class="middle-right">クライアントディレクトリにファイルが欠落</td> <td class="middle-right">クライアントソースディレクトリに指定されたファイルを作成</td> </tr> <tr> <td class="middle-right">クライアントディレクトリ内のファイルが破損</td> <td class="middle-right">指定されたエラーを修正するか、有効なターゲットを指定</td> </tr> <tr> <td rowspan="8" class="left pos-re">関数</td> <td class="middle-right">設定または機能の使用対象となる関数がリモートコンソールにない</td> <td class="middle-right">コンソールで新しい関数を作成するか、コンソールに関数をデプロイ</td> </tr> <tr> <td class="middle-right">設定時に--memoryオプションの値が無効</td> <td class="middle-right">オプションに有効な数値を指定</td> </tr> <tr> <td class="middle-right">削除する関数がローカルマシンに見つからない</td> <td class="middle-right">一覧から利用可能な関数を選択して削除</td> </tr> <tr> <td class="middle-right">ローカルマシンに削除する関数がない</td> <td class="middle-right">プロジェクトディレクトリに新しい関数を作成</td> </tr> <tr> <td class="middle-right">削除する関数がリモートコンソールに見つからない</td> <td class="middle-right">一覧から利用可能な関数を選択して削除</td> </tr> <tr> <td class="middle-right">リモートコンソールに削除する関数がない</td> <td class="middle-right">コンソールで新しい関数を作成するか、コンソールに関数をデプロイ</td> </tr> <tr> <td class="middle-right">ローカルマシンで関数IDを使用して削除できない</td> <td class="middle-right">関数名を使用するか、関数識別子を指定せずにコマンドを実行</td> </tr> <tr> <td class="middle-right">削除時に--localと--remoteオプションを同時に使用できない</td> <td class="middle-right">一度にどちらか一方のオプションのみを使用</td> </tr> <tr> <td rowspan="5" class="left pos-re">設定ファイル</td> <td class="middle-right">設定ファイルで指定された関数が見つからない</td> <td class="middle-right">functionsキーに有効な関数名を指定</td> </tr> <tr> <td class="middle-right">設定ファイルで指定されたクライアントが見つからない</td> <td class="middle-right">clientキーに有効なクライアントソースディレクトリを指定</td> </tr> <tr> <td class="middle-right">設定ファイルで指定されたディレクトリが見つからない</td> <td class="middle-right">プロジェクトディレクトリで利用可能な有効なディレクトリ名を指定</td> </tr> <tr> <td class="middle-right">設定ファイルに無効なターゲット</td> <td class="middle-right">設定ファイルのtargetsに有効な値を指定</td> </tr> <tr> <td class="middle-right">プロジェクトルートディレクトリにファイルが欠落</td> <td class="middle-right">プロジェクトを再度初期化</td> </tr> <tr> <td rowspan="4" class="left pos-re">スクリプト</td> <td class="middle-right">無効なスクリプトコマンド</td> <td class="middle-right">有効な形式でコマンドを指定</td> </tr> <tr> <td class="middle-right">無効な機能が指定された</td> <td class="middle-right">スクリプトを実行するための有効な機能を指定</td> </tr> <tr> <td class="middle-right">ファイルにスクリプトが存在しない</td> <td class="middle-right">利用可能なスクリプトを実行</td> </tr> <tr> <td class="middle-right">スクリプトがエラーで終了した</td> <td class="middle-right">エラーを修正して再試行</td> </tr> <tr> <td rowspan="8" class="left pos-re">イベント生成</td> <td class="middle-right">オプションがペアで指定されていない</td> <td class="middle-right">正しい形式でオプションをペアとして指定</td> </tr> <tr> <td class="middle-right">ソースが無効</td> <td class="middle-right">利用可能なソースを指定<br></td> </tr> <tr> <td class="middle-right">オプションの形式が無効</td> <td class="middle-right">有効な形式でオプションを指定</td> </tr> <tr> <td class="middle-right">カスタムイベントにEvent Bus名が欠落</td> <td class="middle-right">Event Bus名を指定</td> </tr> <tr> <td class="middle-right">カスタムイベントにルール識別子が欠落</td> <td class="middle-right">ルール識別子を指定</td> </tr> <tr> <td class="middle-right">リモートコンソールにEvent Busが見つからない</td> <td class="middle-right">利用可能なEvent Bus名を指定</td> </tr> <tr> <td class="middle-right">アクションがソースと互換性がない</td> <td class="middle-right">ソースと互換性のあるアクションを指定</td> </tr> <tr> <td class="middle-right">セグメント/テーブル/フォルダの識別子が不正</td> <td class="middle-right">オプションに有効な識別子を指定</td> </tr> <tr> <td rowspan="3" class="left pos-re">イベント生成: Integration関数</td> <td class="middle-right">Cliq統合イベントの入力値が不正</td> <td class="middle-right">正しい形式で入力を指定</td> </tr> <tr> <td class="middle-right">Cliqコンポーネントの不明な組み合わせ</td> <td class="middle-right">一覧から適切なCliqコンポーネントの組み合わせを選択</td> </tr> <tr> <td class="middle-right">統合サービスが利用不可</td> <td class="middle-right">利用可能な統合サービスを指定</td> </tr> <tr> <td class="left pos-re">プル</td> <td class="middle-right">コマンドの値が無効</td> <td class="middle-right">コマンドにclient、functions、またはapigの値を指定</td> </tr> <tr> <td rowspan="2" class="left pos-re">サーブ</td> <td class="middle-right">サーブする有効なコンポーネントがない</td> <td class="middle-right">エラーを修正して再試行</td> </tr> <tr> <td class="middle-right">指定された範囲のポートが利用不可</td> <td class="middle-right">指定された範囲外のポートを指定</td> </tr> <tr> <td class="left pos-re">シェル</td> <td class="middle-right">サーブする有効な関数がない</td> <td class="middle-right">エラーを修正して再試行</td> </tr> <tr> <td rowspan="2" class="left pos-re">デプロイ</td> <td class="middle-right">デプロイ準備ができている関数がない</td> <td class="middle-right">適切なオプションを付けてdeployコマンドを実行</td> </tr> <tr> <td class="middle-right">APIGデプロイがスキップされた</td> <td class="middle-right">ローカルでAPI Gatewayを有効にし、再度デプロイ</td> </tr> <tr> <td rowspan="7" class="left pos-re">Java関数の設定</td> <td class="middle-right">設定ファイルで指定されたパスにJARファイルが欠落</td> <td class="middle-right">JARファイルへの有効なパスを指定</td> </tr> <tr> <td class="middle-right">関数ディレクトリ内のファイルが破損</td> <td class="middle-right">破損したファイルを削除してコマンドを再度実行</td> </tr> <tr> <td class="middle-right">設定ファイルでプロジェクト名が一致しない</td> <td class="middle-right">プロジェクト名を適切な値に変更</td> </tr> <tr> <td class="middle-right">Javaコンパイラのバージョンチェック失敗</td> <td class="middle-right">Javaコンパイラがインストールされていることを確認してコマンドを再度実行</td> </tr> <tr> <td class="middle-right">Javaコンパイラが互換バージョンより上位</td> <td class="middle-right">Javaコンパイラをサポートされているバージョンにダウングレード</td> </tr> <tr> <td class="middle-right">関数ディレクトリにメインファイルが欠落</td> <td class="middle-right">設定ファイルに有効なメインファイルを指定</td> </tr> <tr> <td class="middle-right">Javaコンパイルエラー</td> <td class="middle-right">指定されたエラーを修正して続行</td> </tr> <tr> <td class="left pos-re">Node.js関数の設定</td> <td class="middle-right">関数ディレクトリにメインファイルが欠落</td> <td class="middle-right">設定ファイルに有効なメインファイルを指定</td> </tr> <tr> <td rowspan="8" class="left pos-re">オプションの使用</td> <td class="middle-right">オプションに重複するターゲットが指定された</td> <td class="middle-right">重複した値を削除して再試行</td> </tr> <tr> <td class="middle-right">オプションに無効なターゲットが指定された</td> <td class="middle-right">指定された通りに有効なターゲットを指定</td> </tr> <tr> <td class="middle-right">フィルターありとフィルターなしの両方でターゲットが指定された</td> <td class="middle-right">有効な形式でターゲットを指定</td> </tr> <tr> <td class="middle-right">クライアントターゲットをデバッグできない</td> <td class="middle-right">-\-debugのターゲットからクライアントを削除して再試行</td> </tr> <tr> <td class="middle-right">オプション使用の競合</td> <td class="middle-right">一度に1つのオプションのみを使用</td> </tr> <tr> <td class="middle-right">オプションの入力値が無効</td> <td class="middle-right">指定された通りに有効な入力値を指定して再試行</td> </tr> <tr> <td class="middle-right">APIGを単独でサーブできない</td> <td class="middle-right">関数やクライアントなど、少なくとも1つの他のコンポーネントを含める</td> </tr> <tr> <td class="middle-right">プロジェクトオプション指定時にOrgオプションが必要</td> <td class="middle-right">-\-projectまたは-pを使用して特定のプロジェクトを参照する場合、-\-orgを使用してプロジェクトが属する組織のOrg IDを指定</td> </tr> <tr> <td rowspan="4" class="left pos-re">一般</td> <td class="middle-right">コマンド実行中にCatalystアプリディレクトリにいない</td> <td class="middle-right">有効なCatalystディレクトリからコマンドを実行するか、プロジェクトを初期化してCatalystアプリディレクトリにする</td> </tr> <tr> <td class="middle-right">コマンドの不正な使用方法</td> <td class="middle-right">catalyst helpを使用するか、--helpオプションを付けてコマンドを実行して使用方法を確認</td> </tr> <tr> <td class="middle-right">ファイルを読み込めない</td> <td class="middle-right">指定されたエラーを修正して続行</td> </tr> <tr> <td class="middle-right">要求されたポートが利用不可</td> <td class="middle-right">コマンドに別のポートを指定</td> </tr> </tbody> </table> </div> ### スクリプト -------------------------------------------------------------------------------- title: "はじめに" description: "Catalystは、テストまたはデプロイプロセス中のCLIおよびターミナルコマンドの実行を自動化する機能をスクリプトの形で提供します。" last_updated: "2026-08-17T13:08:49.640Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/scripts/introduction/" service: "All Services" -------------------------------------------------------------------------------- # スクリプト ### はじめに Catalystは、テストまたはデプロイプロセス中のCLIおよびターミナルコマンドの実行を自動化する機能をスクリプトの形で提供します。CatalystスクリプトはCatalystプロジェクトディレクトリの catalyst.json ファイルで定義できます。 スクリプトにより、タスクランナーの背後にあるプロセスの詳細を抽象化できます。これにより、反復的なタスクを手動で実行することを防ぎ、テストまたはデプロイプロセスのさまざまな段階で実行する必要のあるロジックを自動化できます。 Catalystは2種類のスクリプトをサポートしています： 1. ライフサイクルスクリプト: さまざまなライフサイクルイベント中に実行されるスクリプト 2. カスタムスクリプト: 必要なときに実行されるよう定義できるスクリプト CLIを使用して、スクリプトを手動で実行し、必要に応じてテストすることもできます。 -------------------------------------------------------------------------------- title: "ライフサイクルスクリプトとカスタムスクリプト" description: "Catalystは、テストまたはデプロイプロセス中のCLIおよびターミナルコマンドの実行を自動化する機能をスクリプトの形で提供します。" last_updated: "2026-08-17T13:08:49.640Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/scripts/lifecycle-and-custom-scripts/" service: "All Services" -------------------------------------------------------------------------------- # ライフサイクルスクリプトとカスタムスクリプト スクリプトの記述方法を学ぶ前に、Catalystでサポートされている2種類のスクリプトについて説明します。 Catalystは次のライフサイクルスクリプトをサポートしています： 1. preserve: このスクリプトは、 catalyst serve コマンドの実行前に自動的に実行されます。 2. postserve: このスクリプトは、 catalyst serveコマンドの実行後に自動的に実行されます。 3. predeploy: このスクリプトは、 catalyst deploy コマンドの実行前に自動的に実行されます。 4. postdeploy: このスクリプトは、 catalyst deployコマンドの実行後に自動的に実行されます。 カスタムスクリプトを設定して、ライフサイクルスクリプト内で呼び出すことにより、必要なタイミングで必要な順序で自動的に実行できます。 注意: 1. 上記のすべてのスクリプトは、現在のCatalystコンポーネントのソースディレクトリで実行されます。 2. コンポーネントのテストまたはデプロイ時に、catalyst.jsonファイルで設定されたライフサイクルスクリプトの実行をスキップすることもできます。そのためには、catalyst serveまたはcatalyst deployを-\-ignore-scriptsオプション付きで実行する必要があります。詳細については、それぞれのヘルプページを参照してください。 -------------------------------------------------------------------------------- title: "スクリプトの記述" description: "Catalystは、テストまたはデプロイプロセス中のCLIおよびターミナルコマンドの実行を自動化する機能をスクリプトの形で提供します。" last_updated: "2026-08-17T13:08:49.640Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/scripts/write-script/" service: "All Services" -------------------------------------------------------------------------------- # スクリプトの記述 ### はじめに プロジェクトのクライアントとファンクションのスクリプトを定義して実行できます。スクリプトを通じて、Catalyst CLIコマンドやローカル環境のターミナルコマンドを実行できます。 スクリプトは、プロジェクトディレクトリのルートにある catalyst.json ファイルのfunctionsまたはclientスコープ内のscriptsフィールドに記述する必要があります。このファイルには、プロジェクトディレクトリコンポーネントの設定とターゲット情報が含まれています。catalyst.json設定ファイルのサンプルコード構造を以下に示します。 <br> ### サンプルスクリプト 上の画像に示されたスクリプトについて説明します。このcatalyst.jsonファイルのコードは、2つのライフサイクルスクリプトと2つのカスタムスクリプトを定義しています。ライフサイクルスクリプトの実行によりカスタムスクリプトが実行されます。ここでのスクリプトは、プロジェクトのクライアントコンポーネント用に定義されているため、クライアントのスコープ内に含まれています。 コードは以下のとおりです： { "functions": { "targets": [ "catly" ], "ignore": [], "source": "functions" }, "client": { "source": "client/app/build", "ignore": [], "scripts": { "packageJson": "cd client && cp client-package.json app/build/", "build": "cd client/app && yarn install && yarn build", "preserve": "catalyst run client:build && catalyst run client:packageJson", "predeploy": "catalyst run client:build && catalyst run client:packageJson" } } } 上記の例のように、ライフサイクルスクリプト内でカスタムスクリプトを catalyst run コマンドを使用して実行する場合、実行対象のコンポーネントを指定する必要があります。これは、たとえばcd（ディレクトリ変更）ターミナルコマンドを実行する場合に必要です。そのコンポーネントのディレクトリのルートが、ディレクトリ変更コマンドの実行元ディレクトリとみなされます。 <br> 上記で記述されたスクリプトのロジックフローは次のとおりです： 1. クライアントコンポーネントに対してcatalyst serveまたはcatalyst deployコマンドを実行すると、コマンドの実行前にそれぞれpreserveまたはpredeployスクリプトが開始されます。 2. preserveとpredeployスクリプトには同じコマンド実行が含まれています。最初のアクションはcatalyst run client:buildコマンドで、クライアントコンポーネントのbuildカスタムスクリプトを実行します。2番目のアクションはcatalyst run client:packageJsonで、クライアントコンポーネントのpackageJsonスクリプトを実行します。 3. buildカスタムスクリプトは次のアクションを順番に実行します： * ターミナルがclient/appディレクトリに移動します。 * yarn installコマンドが実行され、Yarnパッケージマネージャーを使用してNode.jsの依存関係がインストールされます。 * yarn buildコマンドが実行され、クライアントアプリケーションがビルドされます。 4. packageJsonカスタムスクリプトは次のアクションを順番に実行します： * ターミナルがclientディレクトリに移動します。 * client-package.jsonファイルがクライアントディレクトリからコピーされ、app/buildディレクトリに貼り付けられます。 これらのスクリプトが実行された後、コンポーネントがサーブまたはデプロイされます。 -------------------------------------------------------------------------------- title: "スクリプトの実行" description: "Catalystは、テストまたはデプロイプロセス中のCLIおよびターミナルコマンドの実行を自動化する機能をスクリプトの形で提供します。" last_updated: "2026-08-17T13:08:49.641Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/scripts/run-script/" service: "All Services" -------------------------------------------------------------------------------- # スクリプトの実行 CLIを使用して、必要なときにスクリプトを手動で実行し、その実行をテストすることもできます。 プロジェクトディレクトリに移動し、次のいずれかのCLIコマンドを実行することで、プロジェクトディレクトリで利用可能なスクリプトを一覧表示できます： catalyst run-script | run <br> CLIは、 catalyst.json ファイルで各コンポーネントに設定されている利用可能なライフサイクルスクリプトとカスタムスクリプトを表示します。 <br> 以下のように、runコマンドにスクリプト名を指定して、スクリプトを直接実行できます： catalyst run-script | run [command] たとえば、カスタムスクリプトpackageJsonを実行するには、プロジェクトディレクトリから次のコマンドを実行します： catalyst run client:packageJson <br> これにより、例で定義されたpackageJsonスクリプトが実行されます。 ### プロジェクトディレクトリ構造 -------------------------------------------------------------------------------- title: "はじめに" description: "プロジェクトディレクトリ構造は、CLIからCatalystプロジェクトを初期化した際に作成されるデフォルトのディレクトリ構造を指します。" last_updated: "2026-08-17T13:08:49.641Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/project-directory-structure/introduction/" service: "All Services" -------------------------------------------------------------------------------- # プロジェクトディレクトリ構造 ### はじめに Catalyst CLIから新しいプロジェクトを作成または初期化すると、必要な設定ファイルとともに特定の構造で作成されます。このプロジェクトは作成したディレクトリに保存され、そのディレクトリがプロジェクトのホームディレクトリとみなされます。プロジェクトのボイラープレートコードは、作成時にプロジェクトのホームディレクトリに生成されます。CLIからCatalystプロジェクトまたはその特定のコンポーネントを初期化する方法については、リソースの初期化ヘルプページを参照してください。 CatalystでWebクライアントをホストする前に、このヘルプページで説明する標準のプロジェクトディレクトリ構造にすべてのリソースが含まれていることを確認する必要があります。不一致があると、アプリケーションの本番環境でエラーが発生する可能性があります。 CLIからCatalystプロジェクトを初期化する際に、初期化するコンポーネントを選択するよう求められます。初期化できるCatalystプロジェクトの2つの基本コンポーネントは、ClientとFunctionsです。 すべてのコンポーネントを初期化すると、プロジェクトディレクトリに以下のリソースディレクトリが作成されます： 1. Client 2. Functions 3. catalyst.json これらのリソースを詳しく見ていきましょう。 -------------------------------------------------------------------------------- title: "Functionsディレクトリ" description: "プロジェクトディレクトリ構造は、CLIからCatalystプロジェクトを初期化した際に作成されるデフォルトのディレクトリ構造を指します。" last_updated: "2026-08-17T13:08:49.641Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/project-directory-structure/functions-directory/" service: "All Services" -------------------------------------------------------------------------------- # Functionsディレクトリ ### はじめに 前述のとおり、CatalystはJava、Node.js、Pythonプログラミング環境で記述されたFunctionをサポートしています。プロジェクトディレクトリ内のfunctionsフォルダには、マイクロサービスまたはアプリケーションのすべてのサーバーサイドFunctionが個別のフォルダに格納されます。 Functionsディレクトリ内の個々のFunctionフォルダには、メインFunctionファイル（.javaクラスファイル、.jsファイル、または.pyファイル）、およびFunctionに必要なすべての依存関係と設定ファイルが含まれています。Functionのフォルダ内に、メインFunctionと密接に連携する追加のセカンダリFunctionを作成することもできます。 ただし、CLIからFunctionフォルダ内にセカンダリFunctionを作成することはできません。外部の開発環境からフォルダにファイルを手動でインポートするか、Catalystコンソールで作成してCLIを使用してディレクトリにプルします。 注意: CLIを使用してFunctionsディレクトリにJava、Node.js、またはPythonスタックの任意の数のFunctionを追加したり、CLIを使用していつでもFunctionsコンポーネントをセットアップしたりできます。詳しくは、Functionsの操作ヘルプページを参照してください。 プロジェクトディレクトリでCLIからFunctionsを初期化すると、選択したプログラミング環境に基づいた必要な依存関係とともに、プロジェクトディレクトリ内に「functions」という名前のフォルダが作成されます。 <br> **Java** Functionのフォルダは、作成時に以下のコンポーネントでセットアップされます： 1. メインの.javaクラスファイル 2. catalyst-config.json 3. .jarライブラリファイル **Node.js** Functionのフォルダは、作成時に以下のコンポーネントでセットアップされます： 1. メインFunctionファイル（index.js） 2. catalyst-config.json 3. ノードモジュールとNode.js Functionの依存関係 **Python** Functionのフォルダは、作成時に以下のコンポーネントでセットアップされます： 1. main.pyファイル 2. catalyst-config.json 3. requirements.txt ファイル まず、Java、Node.js、Pythonプログラミング環境で共通のメインFunctionファイルとcatalyst-config.jsonファイルについて説明します。 ### メインFunctionファイル メインFunctionファイルは、Functionの初期化時に選択した言語に応じて、.java、.js、または.pyタイプのファイルです。メインFunctionファイルは、Java、Node.js、Pythonのサンプルコード構造で作成されます。 Java Functionの場合、CLIからの初期化時にメインFunctionのクラス名とFunctionグループの参照名を入力する必要があります。Functionフォルダの名前は、Functionの参照名と同じになります。 Node.jsおよびPython Functionの場合、Functionのパッケージ名を入力する必要があります。また、エントリーポイントファイルまたはメインFunctionファイルの名前も入力する必要があり、デフォルトではそれぞれindex.jsとmain.pyという名前になります。 catalyst.jsonファイルには、すべてのFunctionの参照名またはパッケージ名が指定されます。 <br> ### catalyst-config jsonファイル catalyst-config.jsonファイルには、デプロイメントや実行の仕様など、Functionの設定が指定されます。 { "deployment":{ "name": "fn", "stack": "node16", "type": "advancedio", "env_variables": {} }, "execution": { "main": "index.js" } } deployment情報には以下のパラメータが含まれます： * name：初期化時に指定したFunctionグループの参照名です。<br /> Functionの参照名を変更した場合、_catalyst-config.json_の変更を更新し、同じ名前でFunctionフォルダの名前も変更してください。catalyst.jsonにも変更を反映する必要があります。 * stack：Java、Node.js、またはPython Functionであるか、およびバージョン情報を示します。この値を変更するとエラーが発生します。 * type：Functionのタイプを示します。Functionタイプの詳細については、Functionsのヘルプページを参照してください。この値を変更するとエラーが発生します。 executionは、エントリーポイントであるメインFunctionファイル、つまりメインの.java、.js、または.py Functionファイルの名前を指します。 Functionをデプロイする際、catalyst-config.jsonファイルがFunctionフォルダのルートに存在し、正しい設定が含まれていることを確認する必要があります。 次に、Javaライブラリファイル、NodeおよびPython Functionの依存関係について詳しく見ていきましょう： <br> ### Javaライブラリフォルダ libという名前のライブラリフォルダには、Functionの依存JARファイルが含まれています。libフォルダは、CLIからJava環境のFunctionを初期化する際に、Functionディレクトリに自動的に追加されます。 これらのJARファイルはJava SDKパッケージの一部です。ランタイム中、Java Functionは実行に必要なパッケージと機能を含むこれらのライブラリファイルを呼び出します。 <br> ### ノードモジュールとNode.js Functionの依存関係 Node.js Functionのフォルダには、基本的に以下が含まれます： 1. メインFunctionファイル 2. catalyst-config.json 3. package-lock.json 4. package.json 5. ノードモジュールフォルダ メインFunctionファイルとcatalyst-config.jsonファイルについては前述しました。ノードモジュールとNode Functionの依存関係は、Node.js SDKパッケージをインストールする際にシステムにインストールされます。 <br> package.jsonとpackage-lock.jsonファイルは、Functionの設定を含む依存関係ファイルです。package.jsonファイルはFunctionの名前、メインFunctionファイル、バージョン、作者などの情報を指定し、package-lock.jsonはその他の依存関係情報を詳細に指定します。 注意: Functionの名前を変更した場合、これらの設定ファイルに変更を更新する必要があります。 ノードモジュールフォルダには、モジュールのサブフォルダが含まれています。各モジュールには、Node.js Functionの実行に不可欠な個別のライブラリファイル、ライセンスファイル、設定ファイル、インデックスファイルなどが含まれています。 ノードモジュールの1つであるzcatalyst-sdk-nodeには、srcという名前のフォルダにグループ化されたすべてのCatalystコンポーネントのNode.js SDK定義と、その他の依存関係ファイルが含まれています。 注意: * コンソールからFunctionを作成した場合、Functionグループには必要な依存関係がすべて含まれません。たとえば、Node.js Functionグループにはフォルダが作成されますが、ノードモジュールは追加されません。そのような場合、CLIを使用してコンソールからプロジェクトディレクトリにFunctionsをプルできます。これにより、必要な構造でそれらのFunctionのディレクトリが作成されます。コンソールで作成したFunctionグループにセカンダリFunctionが含まれている場合、コンソールからプルする際にFunctionのフォルダに含まれます。 * 外部エディターからFunctionを作成してCatalystにインポートする場合、すべての依存関係が含まれ、すべての設定ファイルが指定された形式で作成されていることを確認する必要があります。不一致があると、Function実行時にエラーが発生する可能性があります。 ### PythonモジュールとFunctionの依存関係 Python Functionのフォルダには、基本的に以下が含まれます： 1. main.pyファイル 2. catalyst-config.json 3. requirements.txt ファイル メインFunctionファイルとcatalyst-config.jsonファイルについては、前のセクションですでに説明しました。 #### requirements.txtファイル このrequirements.txtファイルには、Python Functionの実装に必要なインストール済み依存関係のリストが含まれています。CLIからPython Functionを作成した場合、デフォルトでCatalystのPython SDKパッケージ（zcatalyst-sdk）のエントリが含まれます。Functionに外部の依存関係やライブラリをインストールする場合、requirements.txtファイルにキーバリューペアの形式で依存関係の名前と値を手動で設定して保存する必要があります。 また、requirements.txtファイルで適切なバージョン値を設定して保存するだけで、Python SDKパッケージや外部依存関係のバージョンをアップグレードすることもできます。更新された設定を反映するには、CLIからPython Functionを配信またはデプロイしてください。 -------------------------------------------------------------------------------- title: "Clientディレクトリ" description: "プロジェクトディレクトリ構造は、CLIからCatalystプロジェクトを初期化した際に作成されるデフォルトのディレクトリ構造を指します。" last_updated: "2026-08-17T13:08:49.641Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/project-directory-structure/client-directory/" service: "All Services" -------------------------------------------------------------------------------- # Clientディレクトリ プロジェクトディレクトリ内のclientフォルダには、アプリケーションのフロントエンドのすべてのコンポーネントが含まれています。これには、ウェブページのHTMLファイル、CSSファイル、ウェブページのアクション可能な要素を有効にするJavaScriptファイル、およびその他の必要なファイルが含まれます。 ### Clientディレクトリファイル デフォルトでは、clientフォルダは以下のファイルでセットアップされます： <br> index.html: index.htmlファイルは、Webアプリケーションのホームページのデフォルトファイル名です。サンプルコード構造で作成されます。 main.css: main.cssファイルには、Webアプリケーションのページのスタイリングが含まれています。空のファイルとして作成されます。 main.js: main.jsファイルは、Webアプリケーションのホームページの機能を定義します。空のファイルとして作成されます。 <br> ### client-package jsonファイル client-package.jsonは、Clientリソースの設定ファイルです。デフォルトで以下のアプリケーション仕様が含まれています： { "name":"shipmentTracking", "version":"0.0.2", "homepage":"index.html", "login_redirect":"home.html", "404":"custom404.html" } * name: Webクライアントの名前です。名前を設定してアプリケーションをホストした後は、変更しないでください。ホスト後にWebアプリケーションの名前を変更すると、エラーが発生します。 * version: ホストされているWebアプリケーションのバージョンで、小数形式です。アプリケーションの更新ごとに、バージョン番号を増分方式で変更できます。バージョン番号を減らすことはできません。 * homepage: WebアプリケーションのホームページのURLです。index.htmlファイルの名前を変更した場合、このファイルの値もそれに応じて変更する必要があります。 <br> これらの必須仕様に加えて、以下のプロパティも含めることができます： * description: Webアプリケーションの説明です。バージョンアップグレード時に変更できます。 * login\_redirect: Webアプリケーションへのログイン成功後にユーザーがリダイレクトされるページです。 * 404: アプリケーション用に作成できるカスタム404ページです。アプリケーションのユーザーが存在しないページにアクセスして404エラーが発生するたびに、このカスタムページにリダイレクトされます。 注意: * 404キーを使用してカスタム404ページへのパスを指定する場合、そのファイルには任意の名前を付けることができます。client-package.jsonファイルで404キーを設定しない場合でも、ディレクトリに正確に404.htmlという名前のページを含めることができます。 * Catalystはclientpackage.jsonファイル内の404キーを検索します。存在する場合、アプリケーションで404エラーが発生した際にCatalystはそのファイルをレンダリングします。アプリにカスタム404ページのパスが指定されていない場合、Catalystはクライアントディレクトリ内の_404.html_という名前のファイルを検索します。どちらも存在しない場合、ユーザーはCatalystが提供するデフォルトの404ページにリダイレクトされます。 <br> Webアプリケーションのクライアントファイルをさらに追加し、必要に応じてclientフォルダ内にサブフォルダを作成できます。ただし、client-package.jsonファイルは、クライアントリソースのルートにのみ必ず配置する必要があり、サブフォルダ内には配置できません。 注意: * Webアプリケーションのホームページとclient-package.jsonファイルは、クライアントディレクトリに必ず存在する必要があります。CSSおよびJSファイルは、アプリケーションの機能に基づいてオプションです。必要ない場合は、main.cssとmain.jsファイルを削除できます。 * Webアプリケーションをホストする際、client-package.jsonファイルに記載されている仕様が正確であり、上記のすべてのガイドラインに従っていることを確認する必要があります。Webアプリケーションのホスティングの詳細については、Web Client Hostingを参照してください。 * プロジェクトでの作業中に、CLIを使用していつでもClientコンポーネントをセットアップできます。詳しくは、Clientの操作を参照してください。 -------------------------------------------------------------------------------- title: "catalyst.json" description: "プロジェクトディレクトリ構造は、CLIからCatalystプロジェクトを初期化した際に作成されるデフォルトのディレクトリ構造を指します。" last_updated: "2026-08-17T13:08:49.641Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/project-directory-structure/catalyst-json/" service: "All Services" -------------------------------------------------------------------------------- # catalyst.json設定ファイル catalyst.jsonファイルには、プロジェクトのディレクトリ全体、つまりFunctionsとClientディレクトリの設定が含まれています。以下にサンプルスニペットを示します： { "functions": { "targets": [ "fn", "sendemail", "jaavafn", "mynode", "cert_gen_function" ], "ignore":[ ".output", ], "source":"functions" }, "client":{ "source":"client" } } ### パラメータ FunctionsとClientディレクトリの以下の仕様が含まれています： * source: sourceは、FunctionsとClientディレクトリのターゲットフォルダ名を指定します。これらの値を変更しないでください。 * targets: targetsは、プロジェクト内の各Functionのディレクトリ名を指定します。 * ignore: このフィールドは、コンポーネントディレクトリまたはそのサブディレクトリ内で、本番環境へのコードデプロイ時に無視するファイルを指定します。無視するファイルは角括弧内に記述できます。 ファイルを直接リストするか、グロブパターンを使用してファイルを指定できます。たとえば、_\*.css_を指定すると、そのディレクトリ内のすべてのCSSファイルがデプロイ時に無視されます。 ### 注意事項 * catalyst.jsonファイルは、CLIからのプロジェクト作成時にどのコンポーネントを初期化したかに関係なく、プロジェクトディレクトリに作成されます。コンポーネントを1つも選択しなくても、catalyst.jsonファイルは作成されます。そのため、Catalyst UIコンソールからプロジェクトを作成する場合、プロジェクトリソースの設定情報を含むcatalyst.jsonを作成するには、CLIから初期化する必要があります。 * Catalystコンソールからwebアプリケーションをホストする場合、つまりClientリソースのホストとFunctionsのデプロイをコンソールから個別に行う場合、catalyst.jsonファイルは必須ではありません。ただし、CLIからアプリケーション全体をデプロイする場合、またはGitHubなどの外部ソースからデプロイする場合、catalyst.jsonファイルはアプリケーションのルートフォルダに必ず存在する必要があります。 * FunctionsまたはClientディレクトリの名前を変更した場合、catalyst.jsonに変更を更新する必要があります。 * いずれかのFunctionの名前を変更した場合、catalyst.jsonに変更を更新する必要があります。 * CLIから catalyst functions:setup 、 catalyst functions:add 、 catalyst client:setup 、または catalyst pull コマンドを実行すると、FunctionまたはClientの設定情報はcatalyst.jsonファイルに自動的に更新されます。 * 外部の開発環境からコンポーネントファイルを手動でインポートする場合、このヘルプページで説明されている形式で設定ファイルを作成する必要があります。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEでcatalyst.jsonを使用してCatalystリソースの配信とデプロイを行う手順はこちらをご覧ください。 ### プロジェクトのエクスポートとインポート -------------------------------------------------------------------------------- title: "はじめに" description: "Catalystでは、プロジェクトをその設定とコードを含めてZIPファイルとしてエクスポートし、ZIPファイルを任意の新しいプロジェクトにインポートできます。" last_updated: "2026-08-17T13:08:49.642Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/export-and-import-projects/introduction/" service: "All Services" -------------------------------------------------------------------------------- # プロジェクトのエクスポートとインポート ### はじめに Catalyst CLIは、ローカル環境からIaCプロジェクトのエクスポートおよびインポート操作を実行する機能を提供します。Catalystプロジェクトを、そのコンポーネントの設定とコードを含めて、外部ZIPファイルとしてエクスポートできます。その後、ZIPファイルを新しいプロジェクトとして任意のCatalystアカウントにインポートできます。 プロジェクトのエクスポートは、ローカル環境のアクティブなプロジェクトディレクトリから行われます。プロジェクトをエクスポートすると、同じディレクトリに特定の形式でエクスポートZIPファイルが作成されます。プロジェクトをインポートできるのは、このZIPファイルがこの標準形式の場合のみです。CLIでは、インポート対応のZIPファイルを生成するpackコマンドを使用して、最初にエクスポートすることなく、ローカルディレクトリから直接プロジェクトをインポートすることもできます。 プロジェクトのエクスポートとインポート機能により、データセンター間またはCatalystアカウント間でプロジェクトを簡単に転送できます。また、GitHubリポジトリなどの外部環境からプロジェクトに簡単にアクセスしてテストすることもできます。Catalystプロジェクトのコンポーネントを含むGitリポジトリを単純にクローンし、ZIPファイルを生成してインポートし、プロジェクトを簡単にテストできます。CIシステムなどのリモートシステムを通じてこれらのアクションを簡単に実行したり、スクリプトを記述してこれらのタスクを自動化したりすることもできます。 Catalystは、プロジェクトをCatalystリモートコンソールのみにインポートするか、リモートコンソールとローカル環境の両方にインポートするかのオプションも提供しています。 注意: リモートコンソールの一般設定からIaCプロジェクトのエクスポートおよびインポート操作を実行することもできます。詳細については、 IaC設定ヘルプページ をご覧ください。 -------------------------------------------------------------------------------- title: "エクスポート/インポートZIPファイル形式" description: "Catalystでは、プロジェクトをその設定とコードを含めてZIPファイルとしてエクスポートし、ZIPファイルを任意の新しいプロジェクトにインポートできます。" last_updated: "2026-08-17T13:08:49.642Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/export-and-import-projects/export-import-zip-file/" service: "All Services" -------------------------------------------------------------------------------- # エクスポート/インポートZIPファイル形式 ### ZIPファイルのコンポーネント Catalystでは、データを含めずに、プロジェクトのスキーマと設定をFunctionsとClientコードとともにエクスポートまたはインポートできます。Data Storeテーブルのレコード、アプリケーションのユーザーリストなどのデータは、ZIPファイルに含まれません。 ローカルディレクトリからプロジェクトをエクスポートするときに作成されるZIPファイルには、以下のコンポーネントが含まれます。 * FunctionsディレクトリのZIPファイル: エクスポートZIPには、標準構造のプロジェクトのFunctionsディレクトリが含まれます。プロジェクトディレクトリで初期化されたすべてのFunctionsが、設定ファイルとSDKコンポーネントとともに個別のZIPファイルとして含まれます。 * ClientディレクトリのZIPファイル: エクスポートZIPには、プロジェクトのClientディレクトリも含まれます。プロジェクトで初期化されたWebクライアントは、すべてのClientファイルとともにwebclientフォルダ内のZIPファイルとして含まれます。 * Project-Template JSONファイル: プロジェクトのコンポーネントの設定は、エクスポートZIPファイル内の単一のJSONファイルに含まれます。JSONファイルには、プロジェクトとコンポーネント設定の定義が含まれます。これらの設定には、Data Storeのスキーマとメタデータ、Cacheセグメント、Cronジョブ、Circuit設定、セキュリティルール、メールドメインとアドレス、Event Listenersとルール、API GatewayのAPI、メールテンプレート、ユーザープロファイルなどが含まれます。<br /> <br /> サンプルproject-template JSONからの抜粋を以下に示します： { "name" : "project-template", "version" : "1.0.0", "parameters" : { }, "components" : { "Circuits" : [ { "type" : "circuit", "name" : "InvoiceGen", "properties" : { "name" : "InvoiceGen", "states" : { "State1" : { "next" : "End", "start" : true, "type" : "pass" } } }, "dependsOn" : [ ] } ], "Functions" : [ { "type" : "function", "name" : "warehouseportal", "properties" : { "stack" : "node14", "code" : { "path" : "functions/warehouseportal.zip" }, "configuration" : { "memory" : 256 }, "type" : "basicio", "name" : "warehouseportal" }, "dependsOn" : [ ] } ], "WebClient" : [ { "type" : "client", "name" : "warehousePortal", "properties" : { "app_name" : "warehousePortal", "code" : { "path" : "webclient/warehousePortal.zip" } }, "dependsOn" : [ ] } ], "Cron" : [ { "type" : "cron", "name" : "dailyBackup", "properties" : { "cron_url_details" : { "headers" : { }, "request_body" : "", "request_method" : "POST", "params" : { }, "url" : "https://catalyst.zoho.com/help/index.html" }, "end_time" : -1, "description" : "", "cron_name" : "dailyBackup", "job_detail" : { "hour" : 1, "timezone" : "America/Los_Angeles", "minute" : 0, "second" : 0, "repetition_type" : "Daily" }, "cron_type" : "Calendar", "status" : true }, "dependsOn" : [ ] } ], "Datastore" : [ { "type" : "table", "name" : "InventoryDB", "properties" : { "table_name" : "InventoryDB" }, "dependsOn" : [ ] }, { "type" : "column", "name" : "InventoryDB-ProductID", "properties" : { "decimal_digits" : 2, "column_name" : "ProductID", "data_type" : "int", "is_unique" : false, "is_mandatory" : false, "search_index_enabled" : false, "table_id" : "InventoryDB", "table_name" : "InventoryDB", "max_length" : 10 }, "dependsOn" : [ "Datastore.table.InventoryDB" ] }, { "type" : "tableScope", "name" : "InventoryDB-App Administrator", "properties" : { "role_name" : "App Administrator", "table_scope" : "GLOBAL", "type" : "App Administrator", "table_name" : "InventoryDB" }, "dependsOn" : [ "Datastore.table.InventoryDB" ] }, { "type" : "tableScope", "name" : "InventoryDB-App User", "properties" : { "role_name" : "App User", "table_scope" : "GLOBAL", "type" : "App User", "table_name" : "InventoryDB" }, "dependsOn" : [ "Datastore.table.InventoryDB" ] }, { "type" : "tablePermission", "name" : "InventoryDB-App Administrator", "properties" : { "role_name" : "App Administrator", "type" : "App Administrator", "table_permissions" : [ "SELECT", "UPDATE", "INSERT", "DELETE" ], "table_name" : "InventoryDB" }, "dependsOn" : [ "Datastore.table.InventoryDB" ] }, { "type" : "tablePermission", "name" : "InventoryDB-App User", "properties" : { "role_name" : "App User", "type" : "App User", "table_permissions" : [ "SELECT" ], "table_name" : "InventoryDB" }, "dependsOn" : [ "Datastore.table.InventoryDB" ] }] } } 注意: * ZIPファイルにproject-template JSONファイルが含まれていない場合、Catalystはプロジェクトをインポートできません。これはプロジェクトの設定を定義する必須ファイルです。 * 現在、CatalystプロジェクトのJSONファイルを生成する唯一の方法は、エクスポートすることです。手動で生成することはできません。JSONを直接生成する機能のアップデートは間もなくリリースされる予定です。 -------------------------------------------------------------------------------- title: "プロジェクトのエクスポート" description: "Catalystでは、プロジェクトをその設定とコードを含めてZIPファイルとしてエクスポートし、ZIPファイルを任意の新しいプロジェクトにインポートできます。" last_updated: "2026-08-17T13:08:49.644Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/export-and-import-projects/export-project/" service: "All Services" -------------------------------------------------------------------------------- # プロジェクトのエクスポート ### コマンド実行 ローカルディレクトリにあるプロジェクトをエクスポートすると、CLIはリモートコンソールからプロジェクトのコンポーネント設定を取得します。コンポーネントが設定されていない場合、デフォルトの設定がproject-template JSONファイルに書き込まれます。 注意: * プロジェクトをエクスポートするには、リモートコンソールに必ずプロジェクトが存在する必要があります。 * コンソールにローカルディレクトリに存在しない更新されたFunctionsまたはClientコードがある場合、それらは自動的に取得されます。 <br> 1. ローカルシステムのCatalystプロジェクトディレクトリに関連付けられたプロジェクトをエクスポートするには、ターミナルでそのディレクトリから次のコマンドを実行します： catalyst iac:export これにより、エクスポートジョブが開始されます。Catalystはエクスポート操作に一意のジョブIDを割り当てます。このジョブIDを使用して、いつでもジョブのステータスを確認できます。 <br> 2. エクスポートジョブが完了すると、CLIはエクスポートZIPファイルのダウンロードを求めます。Yを押し、次にEnterを押してZIPをプロジェクトディレクトリにダウンロードします。 ZIPファイルは、前のセクションで説明した標準形式で、functionsおよびclientディレクトリ、および catalyst.json ファイルとともにプロジェクトディレクトリのホームディレクトリに配置されます。 注意: \--project <name\_or\_project\_id>オプションを使用して、コマンドが実行されている現在のディレクトリに関連付けられていないプロジェクトをエクスポートできます。 <br> ### プロジェクトエクスポートオプション #### \--production デフォルトのすべてのCLIアクションである開発環境の代わりに、プロジェクトの本番環境を直接エクスポートできます。 プロジェクトディレクトリからコマンドを実行する際に、\--productionオプションを使用して本番環境を指定することで実行できます： catalyst iac:export --production これにより、前のセクションで説明したのと同じ方法で、本番環境からプロジェクトの設定がエクスポートされます。 -------------------------------------------------------------------------------- title: "プロジェクトのインポート" description: "Catalystでは、プロジェクトをその設定とコードを含めてZIPファイルとしてエクスポートし、ZIPファイルを任意の新しいプロジェクトにインポートできます。" last_updated: "2026-08-17T13:08:49.644Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/export-and-import-projects/import-project/" service: "All Services" -------------------------------------------------------------------------------- # プロジェクトのインポート ### はじめに プロジェクトのインポートオプションを使用すると、新しいCatalystプロジェクトをインポートできます。Catalystは、ソースZIPファイルに基づいてプロジェクトを作成し設定します。project-template JSONで指定された定義に基づいて各コンポーネントを設定し、FunctionsとClientコードがプロジェクトに入力されます。 はじめにで述べたように、プロジェクトを2つの異なる方法でインポートできます： * IaCインポート: IaCインポートコマンドを実行すると、リモートコンソールにのみプロジェクトがインポートされます。ソースZIPファイルに基づいて、コンソールに新しいプロジェクトが作成され設定されます。ローカルディレクトリにこのプロジェクトは見つかりません。 * 初期化によるインポート: CLIから新しいプロジェクトを初期化する際にプロジェクトをインポートすることもできます。 これにより、プロジェクト初期化と同じアクションが実行されます。つまり、プロジェクトはCatalystリモートコンソールとローカル環境の両方にインポートされます。ZIPファイルに基づいて、コンソールに新しいプロジェクトが作成され設定されます。project-template JSONファイル、FunctionsおよびClientコードはローカルディレクトリでも利用できるようになります。 インポート操作のその他のすべての機能は、両方のケースで同じです。 <br> 覚えておくべき重要なポイント： * プロジェクトの定義、FunctionsおよびClientコードを含むソースZIPファイルは、前述のとおり、インポートするために標準形式である必要があります。 * project-template JSONファイルは、ZIPファイルのルートに存在する必要があります。このファイルなしではプロジェクトをインポートできません。functionsまたはclientディレクトリ、または catalyst.json 設定ファイルは必須ではありません。 * catalyst iac:pack コマンドを使用して、既存のCatalystプロジェクトディレクトリをパックし、インポート対応のZIPファイルをいつでも生成できます。 注意: プロジェクトを本番環境に直接インポートすることはできません。 <br> ### IaCインポート 1. IaCインポート方式で新しいプロジェクトをインポートするには、Catalystプロジェクト用の新しいディレクトリを作成して移動し、ターミナルでそのディレクトリから次のコマンドを実行します： catalyst iac:import <br> 2. 新しいプロジェクトの名前を入力し、Enterを押します。<br /> <br> 3. Catalystはコマンドを実行したディレクトリのZIPファイルを確認し、利用可能なZIPファイルからプロジェクトソースとして選択するよう求めます。<br /> ディレクトリにZIPファイルが存在しない場合は、インポートするソースZIPファイルのパスを指定できます。 <br> 4. CLIはユーザーログインセッションを確認するためにブラウザウィンドウにリダイレクトし、インポートジョブが開始されます。ブラウザウィンドウを閉じてターミナルに戻ることができます。<br /> <br> Catalystはインポート操作に一意のジョブIDを割り当てます。このジョブIDを使用して、いつでもジョブのステータスを確認できます。 <br> インポートジョブが完了すると、CLIはそのステータスを表示します。インポートが成功すると、ZIPファイルに基づいてコンポーネント、Functions、Clientが設定された新しいプロジェクトがCatalystリモートコンソールに作成されます。 いつでもコンソールからローカル環境にリソースをプルして、ローカル環境にプロジェクトを取得できます。プロジェクトのプルでは、Functions、Client、API Gatewayルールのみが取得されます。コンポーネントの設定は取得されません。 <br> ### プロジェクトインポートオプション #### \--name プロジェクトのインポート時に、-\\-nameオプションを使用してインポートコマンドでプロジェクト名を直接指定できます： catalyst iac:import --name &lt;project_name&gt; インポートジョブで作成されるプロジェクトの名前を-\\-nameオプションで指定します。CLIは、上記のとおり、ディレクトリ内のZIPファイルの選択またはソースファイルへのパスの入力を求めます。 <br> ### 初期化によるインポート 1. プロジェクト初期化中にプロジェクトをインポートするには、プロジェクト用に作成した新しいディレクトリからプロジェクト初期化コマンドを実行します： catalyst init <br> 2. ディレクトリに関連付けるプロジェクトのリストから「Import an existing project」を選択します。<br /> <br> 3. プロジェクトの名前を入力し、IaCプロジェクトインポートセクションで説明したように、ソースZIPファイルを選択するかパスを指定してインポートします。プロセスは同じです。<br /> Catalystはインポート操作の開始後に一意のジョブIDを割り当てます。インポートジョブが完了すると、リモートコンソールとローカルディレクトリの両方にプロジェクトが作成され設定されます。 <br> これはローカルディレクトリにプロジェクトをインポートするため、プロジェクトの詳細を含む catalyst.json および.catalystrc設定ファイルが作成されます。ZIPファイルに含まれていた場合、プロジェクトディレクトリにはfunctionsおよびclientディレクトリ、およびproject-template JSONファイルも含まれます。 -------------------------------------------------------------------------------- title: "インポート対応ZIPファイルの生成" description: "Catalystでは、プロジェクトをその設定とコードを含めてZIPファイルとしてエクスポートし、ZIPファイルを任意の新しいプロジェクトにインポートできます。" last_updated: "2026-08-17T13:08:49.644Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/export-and-import-projects/generate-zip-file/" service: "All Services" -------------------------------------------------------------------------------- # インポート対応ZIPファイルの生成 ### はじめに Catalystでは、最初にエクスポートすることなく、ローカルディレクトリから直接任意のプロジェクトをインポートできます。つまり、プロジェクトをインポートするために、インポート対応のZIPファイルがローカルシステムにすでに存在している必要はありません。 このコマンドを実行することで、既存のCatalystプロジェクトディレクトリに標準形式のインポート対応ZIPファイルを自動的に生成できます。その後、プロジェクトのインポート時にこのZIPファイルのパスを指定できます。これにより、すべてのファイルとサブディレクトリが必要な形式で存在するかの確認や、各Functionフォルダやクライアントディレクトリを手動で圧縮してインポート用のソースZIPファイルを準備する手間が省けます。 注意: インポート操作にはproject-template JSONファイルが必要なため、packコマンドを実行するディレクトリに必ず存在する必要があります。FunctionsまたはClientディレクトリ、または catalyst.json 設定ファイルは必須ではありません。 <br> ### IaC Pack プロジェクトディレクトリから次のコマンドを実行して、Catalystプロジェクトをパックし、標準形式のZIPファイルを生成できます： catalyst iac:pack これにより、同じディレクトリにZIPファイルが作成されます。 以下に示すように、コマンドの後に名前を指定して、ZIPファイルに任意の名前を付けることもできます。 <br /> -------------------------------------------------------------------------------- title: "エクスポートまたはインポートジョブのステータス取得" description: "Catalystでは、プロジェクトをその設定とコードを含めてZIPファイルとしてエクスポートし、ZIPファイルを任意の新しいプロジェクトにインポートできます。" last_updated: "2026-08-17T13:08:49.644Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/export-and-import-projects/export-import-job-status/" service: "All Services" -------------------------------------------------------------------------------- # エクスポートまたはインポートジョブのステータス取得 ### ステータスの取得 エクスポートまたはインポートジョブがプロジェクトディレクトリで処理中、または最近処理された場合、ジョブのステータスを取得できます。 エクスポートまたはインポートジョブのステータスを取得するには、そのディレクトリから次のコマンドを実行します： catalyst iac:status export|import CLIは、そのディレクトリで処理されたエクスポートまたはインポートジョブのステータスを表示します。 <br> ### ジョブステータスオプション #### \--id &lt;id&gt; ジョブ開始時に自動的に生成された一意のジョブIDを指定して、任意のディレクトリで実行された特定のインポートまたはエクスポートジョブのステータスを取得できます。エクスポートとインポートの両方の操作でジョブIDが生成されます。 任意のエクスポートまたはインポートジョブのステータスを取得するには、次の方法でコマンドにジョブIDを指定します： catalyst iac:status export|import --id &lt;id&gt; CLIはジョブのステータスを表示します。 ### プロジェクトの操作 -------------------------------------------------------------------------------- title: "Catalystプロジェクトの一覧表示" description: "Catalyst CLIを使用すると、Catalystプロジェクトの一覧表示、プロジェクトと作業ディレクトリの関連付け、およびアクティブなプロジェクトのリセットが可能です。" last_updated: "2026-08-17T13:08:49.644Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-projects/list-catalyst-projects/" service: "All Services" -------------------------------------------------------------------------------- # プロジェクトの操作 ### Catalystプロジェクトの一覧表示 CLIから、Catalystユーザーアカウントでアクセスできる組織内のCatalystプロジェクトの一覧を表示できます。 デフォルトに設定されている組織内の既存のCatalystプロジェクトの一覧を表示するには、以下のコマンドを実行します： catalyst project:list <br> デフォルトではない別の組織のプロジェクトを一覧表示する場合は、--orgオプションを付けて同じコマンドを実行し、その組織の一意の組織IDを以下のように指定する必要があります： catalyst project:list --org&lt;org_id&gt; これにより、組織内の既存のCatalystプロジェクトの名前とプロジェクトIDのテーブルが表示されます。 <br> コマンドを実行したディレクトリのベースプロジェクトもプロジェクト一覧に表示されます。これは、そのディレクトリで最初に初期化したプロジェクトです。 一覧には、そのディレクトリでアクティブなプロジェクトも示されます。アクティブなプロジェクトがディレクトリのベースプロジェクトでない場合、CLIはそのことについてアラートを表示します。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用して上記のCLI操作を実行できます。Visual Studio Code IDEを使用してすべてのCatalystプロジェクトの一覧を表示する手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "Catalystプロジェクトの使用" description: "Catalyst CLIを使用すると、Catalystプロジェクトの一覧表示、プロジェクトと作業ディレクトリの関連付け、およびアクティブなプロジェクトのリセットが可能です。" last_updated: "2026-08-17T13:08:49.645Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-projects/use-catalyst-project/" service: "All Services" -------------------------------------------------------------------------------- # Catalystプロジェクトの使用 Catalyst CLIを使用して、作業ディレクトリにCatalystプロジェクトを関連付けることができます。既存のCatalystプロジェクトを追加し、ディレクトリにリンクできます。 ただし、ディレクトリはそのベースプロジェクト（そのディレクトリで初期化したプロジェクト）にのみバインドして永続的に関連付けることができます。そのため、ディレクトリで別のプロジェクトを使用する場合、そのプロジェクトとの関連付けは一時的なものになります。 注意: このコマンドはアクティブなCatalystプロジェクトディレクトリからのみ実行できます。そのため、現在のディレクトリ選択がアクティブなプロジェクトディレクトリでない場合は、代わりにプロジェクトを初期化するか、ディレクトリにコンポーネントをプルしてください。 ### コマンドの実行 1. 作業ディレクトリでCatalystプロジェクトを使用するには、目的のディレクトリから以下のコマンドを実行します： catalyst project:use CLIがデフォルト組織の既存プロジェクトの一覧を表示します。 2. 矢印キーを使用して必要なプロジェクトを選択します。Enterを押して選択を確定します。 プロジェクトが作業ディレクトリに追加され、CLIに確認メッセージが表示されます。 <br> 以下のように、catalyst project:useコマンドにプロジェクトの名前またはプロジェクトIDを指定して、作業ディレクトリで使用することもできます： catalyst project:use [name_or_project_id] 注意: デフォルトではない組織に属するプロジェクトを使用する場合は、--orgオプションを含めて、以下のコマンドを実行してプロジェクトを使用してください： catalyst project:use [name_or_project_id] --org&lt;org_id&gt; <br /> 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用して上記のCLI操作を実行できます。Visual Studio Code IDEを使用して既存の作業ディレクトリにCatalystプロジェクトを追加する手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "アクティブなプロジェクトのリセット" description: "プロジェクトディレクトリ構造とは、CLIからCatalystプロジェクトを初期化する際に作成されるデフォルトのディレクトリ構造を指します。" last_updated: "2026-08-17T13:08:49.645Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/working-with-projects/reset-active-project/" service: "All Services" -------------------------------------------------------------------------------- # アクティブなプロジェクトのリセット 作業ディレクトリの一時的なアクティブプロジェクトをクリアし、ディレクトリが初期化されたベースプロジェクトにリセットできます。プロジェクトのリセットは、catalyst project:useコマンドを元に戻すのに役立ちます。 作業ディレクトリのアクティブプロジェクトをクリアしてベースプロジェクトにリセットするには、ディレクトリに移動して以下のコマンドを実行します： catalyst project:reset 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用して上記のCLI操作を実行できます。Visual Studio Code IDEを使用してCatalystプロジェクトをリセットする手順はこちらをご覧ください。 ### リソースのサーブ -------------------------------------------------------------------------------- title: "はじめに" description: "Catalystでは、CLIを使用して、リモートコンソールにデプロイする前にプロジェクトリソースをローカルでテストすることができます。" last_updated: "2026-08-17T13:08:49.645Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/serve-resources/introduction/" service: "All Services" -------------------------------------------------------------------------------- # リソースのサーブ ### はじめに Catalyst CLIでは、クラウドにデプロイする前に、プロジェクトリソースをローカルでテストすることができます。アプリケーションのライブバージョンに影響を与えることなく、システムのlocalhostを通じてリソースをサーブしてテストできます。 ローカルサーバーを通じてプロジェクトの次のコンポーネントをサーブできます：**Basic I/Oファンクション**、**Advanced I/Oファンクション**、**BrowserLogicファンクション**、**AppSailアプリ**、**Angular Webアプリ**、**React Webアプリ**、および**基本Webアプリ**。 注意: Catalystは、Cron、Event、Integrationファンクションなど、URLを通じてエンドポイントに直接アクセスできない他のタイプのファンクションをサーブすることはできません。 serveコマンドでは、任意のポートからローカルサーバーを起動したり、デバッグモードでサーバーを起動してコードの実行を詳細に分析したりすることもできます。プロジェクトの特定のターゲットをテストしたり、不明なリクエストをローカルホストURLにプロキシしたり、スクリプトを無視したりできます。これらのすべてのアクションは、serveコマンドで利用可能なさまざまなオプションを使用して実行できます。 注意: * Advanced I/Oファンクションを除くすべてのタイプのファンクションをテストおよびデバッグするために、node shellを専用に起動することもできます。詳細については、ファンクションの操作ヘルプページを参照してください。 * ファンクション、クライアント、AppSailパッケージは、それぞれのディレクトリが標準構造になっている場合にのみ正常にサーブできます。ディレクトリには、標準形式の必要な設定ファイルが含まれている必要があります。詳細については、プロジェクトディレクトリ構造のヘルプページを参照してください。 * AppSailアプリをサーブするには、プロジェクトの初期化時または既存のプロジェクトディレクトリへの追加のいずれかでAppSailリソースを初期化しておく必要があります。 * Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールすると、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalystリソースをサーブする手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "すべてのリソースをサーブ" description: "Catalystでは、CLIを使用して、リモートコンソールにデプロイする前にプロジェクトリソースをローカルでテストすることができます。" last_updated: "2026-08-17T13:08:49.645Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/serve-resources/serve-all-resources/" service: "All Services" -------------------------------------------------------------------------------- # すべてのリソースをサーブ ### サーブコマンドの実行 プロジェクトディレクトリに移動して次のコマンドを実行することで、CatalystプロジェクトのBasic I/O、Advanced I/O、BrowserLogicファンクション、AppSailアプリ、Angular、React、および基本Webクライアントコンポーネントをローカルでホストできます： catalyst serve これにより、デフォルトポートでローカルサーバーが起動し、エンドポイントでリソースがサーブされます。 CLIは、サーブされたクライアント、AppSail、およびファンクションエンドポイントのローカルエンドポイントのURLを表示します。 前述のとおり、CatalystはBasic I/O、Advanced I/O、BrowserLogicファンクションのみをサーブできます。そのため、プロジェクトディレクトリにCron、Event、またはIntegrationファンクションがある場合、それらのサーブはスキップされます。同様に、API GatewayルールのJSONファイルもサーブからスキップされます。 <br> ### ファンクションと基本Webアプリケーションのサーブ ローカルサーバーを通じてホストされたBasic I/O、Advanced I/O、BrowserLogicファンクションは、そのURLエンドポイントにアクセスしてテストできます。これらのエンドポイントは、IDE環境またはブラウザからアクセスできます。 Webクライアントは、ローカルサーバーを通じてホストされた後、デフォルトブラウザで自動的に開きます。 注意: \--no-open オプションを使用して、ブラウザでのWebクライアントURLの自動起動を無効にできます。 <br> クライアントのホームページやサブページ、またはファンクションエンドポイントにサーブ後にアクセスすると、CLIはアクセスされたエンドポイントとリクエストメソッドのライブログを表示します。ファンクション呼び出し情報には、以下に示すようにログレベルやその他のログエントリも含まれます。 <br> ### Angularアプリケーションのサーブ プロジェクト内のAngularアプリケーションも同様にサーブされます。Angularアプリの初期化時にインストールされるCatalystプラグイン zcatalyst-cli-plugin-angularがサーブセッションを処理します。 AngularはHot Module Replacement（HMR）を実装しています。HMRはWebpackの機能で、サーブセッション中に変更が加えられた場合、プロジェクト全体を再コンパイルしてリロードすることなく、特定のモジュールを更新してリロードします。Catalyst CLIを通じてアプリケーションをサーブすると、デフォルトでHMRが有効になります。 注意: コンポーネントのサーブ時に \--no-watch オプションを使用して、ライブウォッチを無効にできます。 <br> Angularアプリがサーブされると、/router、/commonなどのアプリ内のモジュールがすべて最初にコンパイルされます。CLIはコンパイルの詳細とビルド生成の情報を表示します。初期チャンクファイルやそのサイズなど、アプリケーション内の個々のファイルの詳細も確認できます。これらはAngularアプリのビルドおよびサーブプロセスのデフォルトの規則に基づいています。 <br> コンパイルが完了すると、CLIはデフォルトブラウザにリダイレクトしてWebクライアントを自動的に開きます。基本Webアプリと同様に、 \--no-open オプションを使用してこれを無効にできます。Angularアプリのサーブセッションでも、アクセスされたエンドポイントとリクエストメソッドのライブログを確認できます。 <br> HMRが無効になっていない場合、Angularアプリで行った変更は、コンポーネント全体の再コンパイルとリロードなしにサーブセッションにライブで反映されます。CLIは、変更されたチャンクファイルの詳細など、更新されたモジュールのライブログを表示します。 <br> ### Reactアプリケーションのサーブ Catalyst ReactアプリはAngularアプリと同様にサーブされます。Reactアプリの初期化時にインストールされるCatalystプラグイン zcatalyst-cli-plugin-react がサーブセッションを処理します。 Reactアプリケーションは、Angularアプリケーションと同様にHot Module Replacement（HMR）を実装しています。HMRはWebpackの機能で、サーブセッション中に変更が加えられた場合、プロジェクト全体を再コンパイルしてリロードすることなく、特定のモジュールを更新してリロードします。Catalyst CLIを通じてアプリケーションをサーブすると、デフォルトでHMRが有効になります。 注意: コンポーネントのサーブ時に-\-no-watch オプションを使用して、ライブウォッチを無効にできます。 <br> Reactアプリがサーブされると、プラグインは開発ビルドにコンパイルします。CLIはコンパイルの詳細とアプリにアクセスするためのローカルエンドポイントを表示します。 <br> コンパイルが完了すると、CLIはデフォルトブラウザにリダイレクトしてWebクライアントを自動的に開きます。基本Webアプリと同様に、 -\\-no-open オプションを使用してこれを無効にできます。Reactアプリのサーブセッションでも、アクセスされたエンドポイントとリクエストメソッドのライブログを確認できます。 HMRが無効になっていない場合、Reactアプリで行った変更は、コンポーネント全体の再コンパイルとリロードなしにサーブセッションにライブで反映されます。CLIは、更新されたモジュールのライブログを表示します。 <br> ### AppSailアプリケーションのサーブ AppSailアプリのサーブプロセスは、アプリのスタック、ランタイム、フレームワーク、および使用される組み込みWebサーバーに応じて開始されます。これらの要素に基づいて、コンパイルされたコードは任意の構造で任意の形式になる可能性があります。詳細については、AppSailの一般的なビルドファイルのヘルプセクションを参照してください。 注意: Catalystは、アプリの初期化時に指定したビルドパスに存在するAppSailアプリのすべての実行可能ファイルをサーブします。すべてのビルドファイルをバンドルまたはzip化する必要はありません。AppSailがアプリケーションのサーブ時に自動的にバンドルします。 <br> アプリに対してスタートアップコマンド、環境変数、および必要なメモリ割り当てを設定しておく必要があります。 注意: <br> * AppSailアプリのサーブに特定のポートやスタートアップコマンドを設定する必要はありません。デプロイ可能なアプリをサーブするだけで、Catalystが必要なすべてのプロセスを内部的に処理します。 * Catalyst CLIはデフォルトでライブウォッチモードを提供し、サーブ中のリソースのホットリロードを実行できます。ただし、これは現在Catalyst AppSailアプリケーションでは利用できず、ライブウォッチモードなしでサーブされます。 <br> プロジェクトリソースのテスト後、ローカル環境に基づいて実行中のコマンドを終了することで、ターミナルのサーブセッションを終了できます。これによりローカルサーバーがシャットダウンされます。 ### Slateアプリのサーブ ローカルのプロジェクトディレクトリに移動して次のコマンドを実行することで、CatalystプロジェクトのSlateアプリケーションをローカルでホストできます： catalyst serve --only slate このcatalyst serveコマンドは、cli-config.jsonファイルで定義されたdev_commandを実行してSlateアプリをローカルで起動します。このdev_commandは、Slateアプリをリンクまたは作成する際にファイルで設定されます。 catalyst serveコマンドを実行する前に、dev_commandを更新して、ZC_SLATE_PORTを含むアプリケーションの起動コマンドを含めるようにしてください。たとえば、Reactアプリで作業している場合は、コマンドを次のように更新します： PORT=$ZC_SLATE_PORT npm start アプリケーションのフレームワークに基づいて起動コマンドを設定する必要があります。Catalyst Slateでサポートされているフレームワークのデフォルト起動コマンドについては、以下の表を参照してください。必要に応じて、アプリケーションのニーズに合わせて起動コマンドを変更できます。 <table class="content-table"> <thead> <tr> <th class="w25p">フレームワーク</th> <th class="w75p">デフォルト起動コマンド</th> </tr> </thead> <tbody> <tr> <td>Create React App</td> <td>PORT=$ZC_SLATE_PORT npm start</td> </tr> <tr> <td>Solid JS(Vite)</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>React + Vite</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Next.js</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Astro</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Angular</td> <td>npm start -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Vue (Vite)</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Preact</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Svelte</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> </tbody> </table> Slateアプリをサーブすると、cli-config.jsonファイルに記載された起動コマンドがローカルサーバーでアプリケーションを実行し、CLIはSlateアプリケーションにアクセスできるURLを表示します。 ローカルでアプリケーションのテストが完了したら、リモートコンソールにデプロイできます。デプロイコマンドについては次のセクションで説明します。 -------------------------------------------------------------------------------- title: "サーブオプション" description: "Catalystでは、CLIを使用して、リモートコンソールにデプロイする前にプロジェクトリソースをローカルでテストすることができます。" last_updated: "2026-08-17T13:08:49.646Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/serve-resources/serve-options/" service: "All Services" -------------------------------------------------------------------------------- # Catalyst Serveオプション Catalyst CLIは、catalyst serveコマンドで使用できるさまざまなオプションを提供しています。 ### \--http &lt;port&gt; デフォルトポート3000以外の任意のポートでリソースをローカルにサーブできます。-\\-httpオプションを使用して、リソースをサーブするポート番号を指定します。 たとえば、ポート2000からリソースをサーブするには、プロジェクトディレクトリから次のコマンドを実行します： catalyst serve --http 2000 <br> ### \--debug &lt;type:port&gt; Catalystでは、ローカルサーバーをデバッグモードで起動し、ライブサーバーにデバッガーをアタッチできます。プロジェクトのBasic I/OおよびAdvanced I/Oファンクションのコードをデバッグできます。コードの開発に使用するIDEのデバッガーインスタンスにサーバーを関連付けることができます。これにより、ファンクションの実行をデバッグし、コード内のエラーや問題を特定できます。 注意: catalyst serve --debugコマンドはJavaおよびNode.jsファンクションでのみ使用可能で、Pythonファンクションではサポートされていません。この目的にはPython IDEを使用し、ローカルデバッガーをアタッチしてください。その後、Pythonファンクションをサーブしてローカルでテストできます。Pythonファンクションのデバッグとサーブの詳細な手順については、このヘルプページを参照してください。 \--http&lt;port&gt; オプションと同様に、任意のポートでサーバーを起動することもできます。Basic I/Oファンクションがデバッガーにアタッチされるデフォルトポートは8010で、Advanced I/Oファンクションは8000です。 <br> プロジェクトディレクトリから次のコマンドを実行して、デバッグモードでローカルサーバーを起動できます： catalyst serve --debug &lt;advancedio:name:port,basicio:port&gt; このオプションを使用する場合、Advanced I/Oファンクションの名前を指定する必要があります。Basic I/Oファンクションの名前は指定する必要はありません。たとえば： catalyst serve --debug advancedio:InvoiceFetch:2000,basicio:4000 <br> これにより、デフォルトポート3000でローカルサーバーが起動されます。リソースがサーブされ、ローカルエンドポイントが表示されます。その後、Advanced I/Oファンクション用にポート2000で、Basic I/Oファンクション用にポート4000でデバッガーをアタッチできます。サーバーはこれらのポートでデバッガーをリッスンします。 <br> このメッセージが表示されたら、IDEを開き、ファンクションに指定したポートにデバッガーをアタッチします。アタッチ後、CLIは確認メッセージを表示します。これでリソースをテストしてデバッグできます。CLIは、デバッガーがキャッチしたエラーとその詳細を表示します。 <br> ### \--proxy&lt;url&gt; Catalystでは、CLIのサーバーが生成したlocalhost URLに不明なリクエストをプロキシできます。これにより、ファンクションのサーブ中に発生したリクエストをプロキシできます。そのようなリクエストはデフォルトでCatalystコンソールにプロキシされます。 serveコマンドの実行時に、不明なリクエストをプロキシするURLを次のように指定できます： catalyst serve --proxy &lt;url&gt; <br> ### \--only&lt;targets&gt; このオプションを使用して、すべてのリソースではなく特定のターゲットをサーブできます。たとえば、特定のファンクションやクライアントパッケージのみをサーブできます。 特定のターゲットをサーブするには、以下のようにcatalyst serveコマンドを-\\-onlyオプションとサーブ対象のターゲットとともに実行します： catalyst serve --only client <br /> <br /> ### \--no-watch Catalyst CLIはデフォルトでライブウォッチモードを提供し、サーブ中のリソースのホットリロードを実行できます。これにより、コードを再コンパイルしたり再サーブしたりすることなく、変更の更新を即座に確認できます。 ただし、ライブウォッチモードを無効にする必要がある場合は、このオプションを使用できます。本番環境用ビルドのサーブ時など、コードを変更する必要がない場合や、更新をライブで反映する必要がない場合に使用できます。 デフォルトのライブウォッチを無効にしてリソースをサーブするには、次のようにします： catalyst serve --no-watch これにより、サーバーは最初にコードがサーブされたときのみコンパイルします。コードがサーブされた後、サーバーは変更を監視しません。リソースをテストする際に更新はライブで反映されません。 デフォルトのライブウォッチモードを再度有効にする必要がある場合は、サーブセッションを終了し、このオプションを使用せずにコードを再サーブする必要があります。 <br> ### \--except&lt;targets&gt; このオプションを使用して、特定のリソースをサーブから除外できます。たとえば、特定のファンクションやクライアントパッケージを除外できます。 特定のファンクションを除外するには、以下のようにcatalyst serveコマンドを\--exceptオプションとターゲット名とともに実行します： catalyst serve -- except functions:InvoiceGeneration <br> ### \--ignore-scripts Catalystでは、プロジェクトディレクトリの catalyst.json ファイルにスクリプトを定義することで、CLIおよびターミナルコマンドの実行を自動化できます。catalyst serveコマンドの前後にそれぞれ実行する2つのライフサイクルスクリプトを定義できます：preserve、postserve。ライフサイクルスクリプトとカスタムスクリプトの詳細については、スクリプトのヘルプページを参照してください。 catalyst serveコマンドの実行時に\--ignore-scriptsオプションを使用すると、CLIはプロジェクトディレクトリのcatalyst.jsonファイルでpreserveおよびpostserveスクリプトに設定されたアクションを無視します。デプロイプロセスは、これらのライフサイクルスクリプトの実行なしに続行されます。 \--ignore-scriptsオプションは次のように使用できます： catalyst serve --ignore-scripts サーブプロセスは前述と同様です。 <br> ### \--no-open serveコマンドを実行してサーバーがコードをホストすると、CLIはデフォルトブラウザに自動的にリダイレクトし、プロジェクト内のクライアントコンポーネントを開きます。この自動リダイレクトを無効にする必要がある場合は、次のようにこのオプションを使用してserveコマンドを実行できます： catalyst serve --no-open CLIは通常どおり、サーブされたすべてのコンポーネントのlocalhost URLを表示します。必要に応じて、URLにアクセスしてWebクライアントを手動で開くこともできます。 このオプションは、クライアントコンポーネントのテストが不要な場合や、本番環境用ビルドのテスト実行時に使用できます。 ### リソースのデプロイ -------------------------------------------------------------------------------- title: "はじめに" description: "Catalystでは、CLIを使用してFunctions、Webクライアント、AppSail、API Gateway、Slateアプリなどのプロジェクトとそのリソースをクラウドに簡単にデプロイできます。" last_updated: "2026-08-17T13:08:49.664Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/deploy-resources/introduction/" service: "All Services" -------------------------------------------------------------------------------- # リソースのデプロイ ### はじめに プロジェクトのリソースを開発してテストした後、CLIからリモートコンソールにデプロイできます。これにより、コンソールのプロジェクトが最新のコードで更新されます。 CLIからデプロイできるコンポーネントは、ローカルのCatalystプロジェクトディレクトリで開発したClient、Functions、AppSail、API Gatewayルール、およびSlateアプリです。Basic Webアプリ、Angularアプリ、Reactアプリの3種類すべてのWebクライアントアプリケーションをデプロイできます。 CLIからリソースをデプロイすると、Catalystプロジェクトの開発環境でのみ利用可能になります。アプリケーションの本番環境には影響しません。リソースを本番環境で利用可能にするには、コンソールからプロジェクトを本番環境にデプロイする必要があります。 また、Catalystコンソールから直接Webクライアントアプリケーションをホストしたり、コンソールで直接Functionsを作成またはアップロードしたりすることもできます。コンソールで直接API GatewayのAPIを設定することもできます。Catalystは、通常のデプロイに加えて、事前に初期化せずにAppSailリソースをデプロイするためのスタンドアロンデプロイオプションもサポートしています。 注意: Catalyst CLIを使用してモバイルアプリケーションのリソースをデプロイすることはできません。Mobile Device Managementを使用してモバイルアプリをホストできます。 <br> ### デプロイコマンドの実行 CLIからリモートコンソールにCatalystプロジェクトとそのすべてのリソースをデプロイするには、プロジェクトディレクトリからターミナルで次のコマンドを実行します： catalyst deploy このコマンドを実行すると、デフォルトでプロジェクトディレクトリ内のすべてのデプロイ可能なリソースがデプロイされます。CLIは作業ディレクトリでアクティブなプロジェクトを対象とします。ディレクトリのベースプロジェクト以外のプロジェクトがアクティブな場合、CLIはその旨を通知する警告を表示します。 デプロイが完了すると、プロジェクトはクラウドコンソールのプロジェクトと同期されます。コンソールからデプロイされたFunctions、Webクライアント、AppSail、Slateアプリ、および更新されたAPI Gatewayの定義にアクセスできるようになります。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalystリソースをデプロイする手順はこちらをご覧ください。 <br> ### 注意事項： * プロジェクトは、そのディレクトリが標準構造でクライアントとFunctionsパッケージを含んでいる場合にのみ正常にデプロイできます。FunctionsとClientディレクトリには、標準形式の必要な設定ファイルが含まれている必要があります。詳細については、プロジェクトディレクトリ構造のヘルプを参照してください。 * CLIを使用してプロジェクトをデプロイする際には、プロジェクトディレクトリに catalyst.json ファイルが存在する必要があります。コンソールからWebクライアントを直接ホストする場合は、このファイルを含める必要はありません。 * API Gatewayルールの定義を含む catalyst-user-rules.json ファイルは、デプロイが必要な場合、プロジェクトのホームディレクトリに存在する必要があります。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalystリソースをデプロイする手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "Functionsのデプロイ" description: "Catalystでは、CLIを使用してFunctions、Webクライアント、AppSail、API Gateway、Slateアプリなどのプロジェクトとそのリソースをクラウドに簡単にデプロイできます。" last_updated: "2026-08-17T13:08:49.665Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/deploy-resources/deploy-functions/" service: "All Services" -------------------------------------------------------------------------------- # Functionsのデプロイ CLIは、デプロイ前にプロジェクトディレクトリ内のすべてのJava Functionsをコンパイルします。コンパイルされたJavaクラスファイルはそれぞれのディレクトリに配置されます。Node.jsおよびPython Functionsは直接デプロイされます。 CLIは各Functionを個別にデプロイします。CLIは各リソースのデプロイステータスを個別に表示し、成功したか失敗したかを示します。 Basic I/OおよびAdvanced I/O Functionsはターミナルに表示されるURLにデプロイされ、そのURLからエンドポイントにアクセスできます。Cron、Event、Browser Logic、およびIntegration Functionsのエンドポイントは、それぞれcronジョブ、イベントリスナー、または外部インテグレーションに関連付けられているため、URLからアクセスすることはできません。CLIはそれらのデプロイステータスのみを表示します。 <br> 注意: CatalystアプリケーションのURLの/server/部分はFunctionを示します。Basic I/O FunctionのURLにはFunction名の後に/executeが含まれますが、Advanced I/O FunctionのURLにはそのキーワードは含まれません。 <br> -------------------------------------------------------------------------------- title: "Clientのデプロイ" description: "Catalystでは、CLIを使用してFunctions、Webクライアント、AppSail、API Gateway、Slateアプリなどのプロジェクトとそのリソースをクラウドに簡単にデプロイできます。" last_updated: "2026-08-17T13:08:49.669Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/deploy-resources/deploy-client/" service: "All Services" -------------------------------------------------------------------------------- # Clientのデプロイ Webクライアントのデプロイにより、ホストされたWebクライアントのURLエンドポイントが生成され、アプリケーションにアクセスできるようになります。 ### Basic Clientアプリケーションのデプロイ Basic Webクライアントはそのままデプロイされます。 <br> ### Angularアプリケーションのデプロイ Angularアプリをデプロイすると、Angularアプリの初期化時にインストールされたCatalystプラグイン zcatalyst-cli-plugin-angular がデプロイを処理します。 polyfillsやランタイムファイルなど、Angularコンポーネントとサービスを表すチャンクファイルが生成されます。チャンクファイルが生成された後にビルドが生成されます。 Angularアプリケーションは出力ディレクトリdist/にコンパイルされビルドされます。このフォルダには、アプリのソースフォルダsrcにあるHTML、CSS、JSまたはTSタイプのエントリーポイントファイル、スタイルシート、テンプレートなど、すべてのコンパイル済みファイルが含まれます。 デプロイの詳細はワークスペース設定ファイルangular.jsonに更新されます。これらは、Angularアプリケーションの標準デプロイ手順に該当します。 CLIはAngularアプリのデプロイ詳細を表示します。デプロイされたWebクライアントのURLエンドポイントが生成されて表示されます。このURLでアプリケーションを開くことができます。 <br> ### Reactアプリケーションのデプロイ Reactアプリをデプロイすると、Reactアプリの初期化時にインストールされたCatalystプラグイン zcatalyst-cli-plugin-react がデプロイを処理します。 プラグインによりReactアプリのコンパイルが有効になります。Reactアプリケーションは出力ディレクトリbuild/にコンパイルされビルドされます。このフォルダには、アプリのソースフォルダsrcにあるHTML、スタイルシート、JSなどのファイルを含む、すべてのコンパイル済みファイルが含まれます。コンパイル後に本番環境用のビルドが生成されます。 ReactアプリをTypeScriptで開発した場合、コンパイル中にコードがJavaScriptにトランスパイルされます。これらは、Reactアプリケーションの標準デプロイ手順に該当します。 CLIはReactアプリのデプロイ詳細を表示します。デプロイされたWebクライアントのURLエンドポイントが生成されて表示されます。このURLでアプリケーションを開くことができます。 <br> 注意: * CatalystアプリケーションのURLの/app/部分はClientコンポーネントを示します。両方の環境のアプリケーションURLは、環境設定セクションから確認できます。 * アプリケーションのURLを次の形式で入力した場合: https://_project\_domain\_name_.development.catalystserverless.com、開発環境で client-package.json ファイルに設定したアプリケーションのホームページに自動的にリダイレクトされます。 <br> -------------------------------------------------------------------------------- title: "AppSailのデプロイ" description: "Catalystでは、CLIを使用してFunctions、Webクライアント、AppSail、API Gateway、Slateアプリなどのプロジェクトとそのリソースをクラウドに簡単にデプロイできます。" last_updated: "2026-08-17T13:08:49.669Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/deploy-resources/deploy-appsail/" service: "All Services" -------------------------------------------------------------------------------- # AppSailのデプロイ ### はじめに Catalystでは、AppSailサービスを2つの異なる方法でデプロイできます： * 通常のデプロイ: 通常のデプロイ実行は、プロジェクトの初期化時または既存のプロジェクトディレクトリに追加することで、すでにAppSailリソースを初期化している場合に適用されます。 * スタンドアロンデプロイ: 事前にAppSailサービスとして初期化せずに、アプリを直接スタンドアロンデプロイできます。 Catalystマネージドランタイムまたはカスタムランタイムとして初期化されたアプリを、これらの両方のデプロイ方法でデプロイできます。以下は、2つの異なる方法で初期化または追加されたAppSailに関する重要なポイントです： * Catalystマネージドランタイム: Catalystは、アプリの初期化時に指定したビルドパスにあるアプリのすべての実行可能ファイルを、プロジェクト設定とともにデプロイします。 注意: すべてのビルドファイルをバンドルしたりzip圧縮したりする必要はありません。AppSailは指定されたビルドパスからアプリケーションの提供またはデプロイ時に自動的にバンドルします。 * コンテナイメージ: AppSailに関連付けられたアプリのOCIイメージが、プロジェクトの設定ファイルとともにデプロイされます。 注意: Catalystは、Linux AMD64（x86-64）プラットフォーム用にビルドされたOCI準拠のイメージのデプロイのみをサポートしています。 <br> ### 通常のデプロイ AppSailアプリがすでにプロジェクトディレクトリで初期化されている場合、catalyst deployコマンドを実行すると、CLIは残りのプロジェクトリソースとともにアプリを自動的にデプロイします。CLIはデプロイ後にアプリのエンドポイントURLを表示し、そのURLで開くことができます。 <br> プロジェクトディレクトリに複数のAppSailアプリがある場合、CLIからすべてのURLエンドポイントにアクセスできます。 アプリのソースディレクトリからAppSailサービスのみをデプロイするには、次のコマンドを実行することもできます。 catalyst deploy appsail デプロイプロセスは同じです。 <br> <br> ### スタンドアロンデプロイ スタンドアロンデプロイコマンドは、Catalystプロジェクトディレクトリのルートから実行する必要があります。つまり、catalyst.jsonおよびその他のプロジェクト依存ファイルがディレクトリに存在する必要があります。 注意: [コンテナイメージのデプロイに固有のオプション](#standalone-deploy-appsail-options)を使用せずにスタンドアロンデプロイコマンドを実行すると、CLIはデフォルトでCatalystマネージドランタイムアプリに関連する入力のみを求めます。 スタンドアロンデプロイについて、以下のポイントを覚えておく必要があります。 Catalystマネージドランタイムアプリ: * コマンドを実行するディレクトリにアプリのデプロイ可能なビルドファイルが存在することを確認する必要があります。これは、そのディレクトリが自動的にビルドディレクトリとして認識されるためです。 * スタンドアロンデプロイでアプリを初期化せずにデプロイする場合、app-config.jsonファイルは作成されません。このファイルが持つ情報は、デプロイ中にCLIで入力として取得されます。 コンテナイメージ: * スタンドアロンデプロイコマンドで以下のオプションを使用して、アプリをコンテナイメージとしてデプロイできます：--name &lt;name&gt;、--source &lt;image&gt;、--command &lt;command&gt;、--port &lt;port&gt;。最初の2つは必須で、最後の2つはオプションであり、コンテナイメージ定義ですでに設定されているスタートアップコマンドやポートを上書きするために使用できます。オプションの詳細は以下で説明します。 <br> AppSailアプリのスタンドアロンデプロイは、次の方法で実行できます： 1. アプリのデプロイ可能なファイルが存在するディレクトリに移動し、次のコマンドを実行します： catalyst deploy appsail 2. アプリの名前を入力します。アプリのビルドのメインファイルに任意の名前を付けることができます。 <br> 注意: ただし、Java WARファイルとしてアプリをビルドする場合は、メインファイルをroot.warと命名するか、コードに応じて特定のコントローラーを追加する必要があります。 3. リストからアプリのビルドパスを選択し、**Enter**キーを押します。 <br> 4. アプリのスタックを選択し、**Enter**キーを押します。 <br> Javaを選択した場合、CLIはさらにJava SEまたはJava WARのいずれかをアプリのデプロイ可能な形式として選択するよう求めます。 <br> 他のスタックを選択した場合、この手順はスキップされます。 5. 使用するスタック、フレームワーク、Webサーバーに基づいて、アプリのスタートアップコマンドを追加で指定する必要があります。この情報は直接デプロイされ、アプリのデプロイ後にコンソールの「Configurations」セクションで確認できます。 <br> これで、AppSailリソースとして初期化することなく、アプリが関連するリモートプロジェクトに直接デプロイされます。CLIに表示されるエンドポイントURLでアクセスできるようになります。 <br> <br> ### スタンドアロンデプロイAppSailオプション catalyst deploy appsailスタンドアロンコマンドは、以下のオプションをサポートしています。一部のオプションはCatalystマネージドランタイムとコンテナイメージアプリの両方に適用されますが、一部は一方にのみ固有です。 --name &lt;name&gt; アプリの名前を指定するために使用します。これはCatalystマネージドランタイムとコンテナイメージアプリの両方に適用されます。例： --name DemoApp --build-path &lt;path&gt; アプリのビルドパスを指定するために使用します。絶対パス値を指定してください。これはCatalystマネージドランタイムアプリにのみ適用されます。例： --build-path /users/amelia/catalystapp/demoapp/ --stack &lt;stack&gt; アプリのスタックまたはランタイムを指定するために使用します。Catalystでサポートされているランタイムのみを指定する必要があります。これはCatalystマネージドランタイムアプリにのみ適用されます。例： --stack NodeJS 20 --platform &lt;javase|war&gt; Catalystでサポートされているプラットフォーム（javaseまたはwar）のJavaスタックのみを指定するために使用します。これはCatalystマネージドランタイムアプリにのみ適用されます。例： --platform javase --command &lt;command&gt; アプリのスタートアップコマンドを指定するために使用します。これはCatalystマネージドランタイムとコンテナイメージアプリの両方に適用されます。コンテナイメージ定義ですでに設定されている値を上書きします。例： --command npm start --source &lt;image&gt; デプロイするDockerイメージのソースを指定するために使用します。これはコンテナイメージアプリにのみ適用されます。Dockerイメージプロトコルの場合は'*docker://*'で、Dockerアーカイブプロトコルの場合は'*docker-archive://*'で開始する必要があります。詳細はこちらを参照。例： --source docker://example-voting-app-worker:latest --port &lt;port&gt; AppSailのポートを指定するために使用します。これはコンテナイメージアプリにのみ適用されます。コンテナイメージ定義ですでに設定されている値を上書きします。例： --port 8000 -------------------------------------------------------------------------------- title: "API Gatewayのデプロイ" description: "Catalystでは、CLIを使用してFunctions、Webクライアント、AppSail、API Gateway、Slateアプリなどのプロジェクトとそのリソースをクラウドに簡単にデプロイできます。" last_updated: "2026-08-17T13:08:49.688Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/deploy-resources/deploy-api-gateway/" service: "All Services" -------------------------------------------------------------------------------- # API Gatewayのデプロイ プロジェクトのAPI GatewayのJSONファイルをクラウドにデプロイできます。これにより、リモートコンソールのローカルAPI定義が更新されます。 注意: プロジェクトでAPI Gatewayが無効になっている場合、API Gatewayルールのデプロイはスキップされます。 -------------------------------------------------------------------------------- title: "Slateへのデプロイ" description: "Catalystでは、CLIを使用してFunctions、Webクライアント、AppSail、API Gateway、Slateアプリなどのプロジェクトとそのリソースをクラウドに簡単にデプロイできます。" last_updated: "2026-08-17T13:08:49.688Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/deploy-resources/deploy-to-slate/" service: "All Services" -------------------------------------------------------------------------------- # Slateへのデプロイ 以下の手順を使用して、Catalyst Slateにフロントエンドウェブアプリケーションをデプロイできます。Slateにアプリケーションをデプロイする前に、プロジェクトディレクトリがSlateサービスにリンクされていることを確認してください。これには、catalyst slate:linkコマンドを使用できます。 Slateサービスのプロジェクトディレクトリからターミナルで次のコマンドを実行します： catalyst deploy slate これにより、プロジェクトディレクトリにあるすべてのSlateコンポーネントがCatalyst開発環境にデプロイされます。 以下のオプションを使用して、Slateデプロイにデプロイメッセージを提供できます。 catalyst deploy slate -m "deployment message" プロジェクトディレクトリから特定のアプリのみをSlateにデプロイするには、以下のコマンドを直接使用できます： catalyst deploy --only slate:appname アプリケーションを本番環境にデプロイする場合は、以下のコマンドを使用してください。本番デプロイを開始する前に、コンソールで本番環境にアクセスしていることを確認してください。 catalyst deploy slate --production -------------------------------------------------------------------------------- title: "デプロイオプション" description: "Catalystでは、CLIを使用してプロジェクトとそのリソースをリモートコンソールに簡単にデプロイできます。" last_updated: "2026-08-17T13:08:49.688Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/deploy-resources/deploy-options/" service: "All Services" -------------------------------------------------------------------------------- # デプロイオプション Catalyst CLIでは、2つのデプロイオプションを使用して、Clientパッケージのみ、特定のFunctions、またはAppSailサービスなど、特定のリソースのみをデプロイできます。以下のオプションはcatalyst deployコマンドで使用できます。 注意: これらのデプロイオプションに加えて、リソースが配置されているターゲットフォルダに移動し、そのフォルダからcatalyst deployコマンドを実行することで、プロジェクトから特定のリソースをデプロイすることもできます。これは、デプロイ可能なリソースがすべて同じディレクトリにある場合に使用できます。たとえば、特定のFunctionのみをデプロイする場合は、CLIでそのFunctionのフォルダに移動し、catalyst deployコマンドを実行できます。 ### \--only &lt;targets&gt; -\\-onlyオプションを使用すると、デプロイする特定のリソースを定義できます。client、functions、appsail、slate、またはapigキーワードと一緒に使用できます。複数のリソースをカンマで区切り、リソース間に空白文字を入れずに指定できます。 たとえば、Clientディレクトリのみをデプロイするには、ターミナルで次のコマンドを実行します： catalyst deploy --only client これにより、Clientディレクトリのみのデプロイが開始されます。デプロイプロセスは前のセクションで説明したものと同じです。 <br> -\\-onlyオプションを使用して、特定のFunctionsまたはAppSailサービスをデプロイすることもできます。以下に示すように、コマンドでターゲットのFunctionsまたはAppSailサービスの名前をカンマで区切って指定する必要があります： catalyst deploy --only functions:InvoiceFetch,functions:CostAccounting <br> 以下に示すように、Clientと特定のFunctions、またはAppSailサービスと特定のFunctionsのみをデプロイすることもできます： catalyst deploy --only functions:InvoiceSync,functions:CostAccounting,functions:FreightTracking <br> これにより、プロジェクトディレクトリから指定されたリソースのみがデプロイされます。 <br > ### \--except &lt;targets&gt; -\\-exceptオプションを使用すると、デプロイから除外するリソースを定義できます。指定したリソース以外のすべてのリソースがデプロイされます。 たとえば、-\\-exceptオプションでclientを指定すると、Clientパッケージが除外され、その他すべてがデプロイされます。次のようにコマンドを実行できます： catalyst deploy --except client このオプションを使用して、特定のFunctionsまたはAppSailサービスを除外することもできます。例： $ catalyst deploy --except appsail:customerapp,functions:CostAccounting これにより、プロジェクトの他のすべてのリソースがデプロイされます。 <br> ### \--ignore-scripts Catalystでは、プロジェクトディレクトリの catalyst.json ファイルでスクリプトを定義して、CLIおよびターミナルコマンドの実行を自動化できます。catalyst deployコマンドの前後にそれぞれ実行される2つのライフサイクルスクリプトを定義できます：predeploy、postdeploy。ライフサイクルおよびカスタムスクリプトの詳細については、スクリプトヘルプページを参照してください。 catalyst deployコマンドの実行時に-\\-ignore-scriptsオプションを使用すると、CLIはプロジェクトディレクトリのcatalyst.jsonファイルでpredeployおよびpostdeployスクリプトに設定されたアクションを無視します。デプロイプロセスは、これらのライフサイクルスクリプトの実行なしで続行されます。 -\\-ignore-scriptsオプションは次のように使用できます： catalyst deploy --ignore-scripts デプロイプロセスは前述と同じです。 注意: Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalyst Functionsを個別にデプロイする手順はこちら、Clientリソースをデプロイする手順はこちらをご覧ください。 ### リソースのプル -------------------------------------------------------------------------------- title: "はじめに" description: "Catalystでは、CLIを使用して、リモートコンソールのCatalystプロジェクトからローカルプロジェクトディレクトリの同じプロジェクトにリソースをプルすることができます。" last_updated: "2026-08-17T13:08:49.689Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/pull-resources/introduction/" service: "All Services" -------------------------------------------------------------------------------- # リソースのプル ### はじめに UIコンソールで作成したCatalystプロジェクトの機能を、CLIに簡単にプルすることができます。これにより、コンソールからプロジェクトのコンポーネントを、CLIの作業ディレクトリでアクティブな同じプロジェクトにダウンロードできます。この機能を使用して、コンソールで行った変更でプロジェクトディレクトリを更新できます。 Catalystプロジェクトの3つのコンポーネントをプルできます：**Client**、**Functions**、**API Gateway Rules**。クライアントとファンクションコンポーネントをプルすると、それぞれのホームディレクトリが作業プロジェクトディレクトリ内に作成されます。API Gatewayルールをプルすると、最新のAPIGルールの定義を含むJSONファイルがプロジェクトのホームディレクトリにプルされます。ディレクトリ構造の詳細については、プロジェクトディレクトリ構造のヘルプページを参照してください。 注意: * 作業ディレクトリにアクティブなCatalystプロジェクトが関連付けられていない場合、リソースをプルすることはできません。リソースをプルする前に、ディレクトリを初期化してCatalystプロジェクトに関連付けていることを確認してください。 * Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールすると、CLIの代わりにIDEを使用して上記のCLI操作を実行できます。Visual Studio Code IDEを使用してCatalystプロジェクトのプル操作を実行する手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "すべてのリソースをプル" description: "Catalystでは、CLIを使用して、リモートコンソールのCatalystプロジェクトからローカルプロジェクトディレクトリの同じプロジェクトにリソースをプルすることができます。" last_updated: "2026-08-17T13:08:49.689Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/pull-resources/pull-all-resources/" service: "All Services" -------------------------------------------------------------------------------- # すべてのリソースをプル ### コマンドの実行 Catalystプロジェクトからリソースをプルするには、リソースをプルしたいプロジェクトディレクトリに移動し、次のコマンドを実行します： catalyst pull これによりプルプロセスが開始されます。 プルしたいリソースを選択します。3つのリソースすべてをプルするか、特定のリソースを選択できます。リソースを選択した後、Enterを押してください。 <br /> ### ファンクションのプル Functionsを選択した場合、コンソールからプロジェクトディレクトリにプルしたいすべてのファンクションをリストから選択します。選択後、Enterを押してください。 これにより、コンソールで利用可能な各ファンクションが、ローカルマシンのプロジェクトのファンクションディレクトリ内のそれぞれのディレクトリにプルされます。 <br> ### クライアントのプル _client_ を選択した場合、プルしたいクライアントアプリのバージョンをリストから選択します。CLIはリモートコンソールにホストされているクライアントアプリケーションのすべてのバージョンを表示します。選択してEnterを押してください。 選択したバージョンのクライアントファイルが、ローカルマシンのプロジェクトのクライアントディレクトリにプルされます。 <br> ### API Gatewayルールのプル API Gateway Rulesを選択した場合、プロジェクトのホームディレクトリに catalyst-user-rules.json ファイルが作成されます。リモートコンソールですべてのAPIに作成された最新の定義がこのファイルに書き込まれます。このファイルについては、API Gateway CLIの操作ヘルプページを参照してください。 リモートコンソールでプロジェクトのAPI Gatewayが無効になっている場合、CatalystはAPI定義をプルする前にCLIから有効にするよう求めます。Yと入力してEnterを押すと、API Gatewayが有効になります。 API Gatewayが有効になっている場合、API定義は自動的にプルされ、catalyst-user-rules.jsonファイルに追加されます。 Catalystは、API GatewayルールのJSONファイルに関する情報を含むように、 catalyst.json ファイルも更新します。 注意: プルするリソースを選択しても、リモートコンソールに存在しない場合、CLIはエラーをスローします。たとえば、リモートコンソールでAPIが作成されていない場合、API Gatewayルールはプルされません。 <br> ### 既存リソースの上書き ファンクションまたはクライアントディレクトリ、あるいはcatalyst-user-rules.jsonファイルがプロジェクトのルートフォルダに存在しない場合、リソースがプルされる前に自動的に作成されます。ただし、リソースがプロジェクトフォルダに既に存在する場合、CLIは既存ファイルの上書きの確認を求めます。 既存ファイルを上書きするにはYを、拒否するにはNを入力してEnterを押してください。上書きを確認すると、プルプロセスが開始されます。拒否すると、プルプロセスは中止されます。 <br /> -------------------------------------------------------------------------------- title: "特定のリソースをプル" description: "Catalystでは、CLIを使用して、リモートコンソールのCatalystプロジェクトからローカルプロジェクトディレクトリの同じプロジェクトにリソースをプルすることができます。" last_updated: "2026-08-17T13:08:49.689Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/pull-resources/pull-specific-resource/" service: "All Services" -------------------------------------------------------------------------------- # 特定のリソースをプル 次の方法で、プロジェクトから特定のリソースをプルできます： catalyst pull [feature] キーワードclient、functions、またはapigを指定する必要があります。たとえば、ファンクションのみをプルするには、プロジェクトディレクトリから次のコマンドを実行します： catalyst pull functions これにより、ディレクトリにプルできるすべてのファンクションが一覧表示されます。前のセクションで説明したように、必要なリソースを選択してプルできます。 ### リソースの初期化 -------------------------------------------------------------------------------- title: "はじめに" description: "CLIからCatalystプロジェクトおよびFunctions、Client、AppSailなどのプロジェクトリソースを初期化できます" last_updated: "2026-08-17T13:08:49.713Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/initialize-resources/introduction/" service: "All Services" -------------------------------------------------------------------------------- # リソースの初期化 ### はじめに Catalyst CLIで作業する最初のステップは、ローカルシステムのディレクトリでCatalystプロジェクトを初期化し、そのディレクトリをプロジェクトに関連付けることです。Catalystプロジェクトを初期化するまで、CLIでプロジェクト関連の操作を実行することはできません。 プロジェクトを初期化するディレクトリは、プロジェクトディレクトリと呼ばれます。プロジェクトに必要な設定ファイルは、プロジェクトの初期化時に自動的に作成されます。 Catalystプロジェクトの4つの基本コンポーネントを初期化できます：Functions、Client、AppSail、およびSlate。初期化するコンポーネントのディレクトリは、必要な設定ファイルと依存関係とともに自動的に作成されます。 プロジェクトディレクトリ構造と設定ファイルのコード構造の詳細については、 **プロジェクトディレクトリ構造のヘルプ** ページを参照してください。 注意: API Gatewayの API定義を含むJSONファイルをリモートコンソールからプロジェクトディレクトリにプルすることもできます。詳しくはAPI Gatewayの操作ヘルプページを参照してください。 <br> 初期化プロセスが完了すると、このディレクトリはそのプロジェクトに永続的にバインドされます。 catalyst project:use コマンドを使用して他のプロジェクトで作業することもできますが、この関連付けは一時的なものです。ディレクトリで最初に初期化したプロジェクトが、そのディレクトリのベースプロジェクトとみなされます。 注意: * ルートがすでに別のプロジェクトにバインドされているディレクトリでは、プロジェクトを初期化できません。ディレクトリでプロジェクトが初期化されると、CLIはディレクトリのルートからCatalystコンポーネントのチェックを実行します。ルートにコンポーネントが見つかった場合、CLIは新しいプロジェクトを初期化しません。 * 新しいプロジェクトを初期化する最善の方法は、ローカルシステムに個別のフォルダを作成し、そこに移動して、そのディレクトリから初期化コマンドを実行することです。 * Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalystプロジェクトを初期化する手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "新しいプロジェクトの初期化" description: "CLIからCatalystプロジェクトおよびFunctions、Client、AppSailなどのプロジェクトリソースを初期化できます" last_updated: "2026-08-17T13:08:49.713Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/initialize-resources/initialize-new-project/" service: "All Services" -------------------------------------------------------------------------------- # 新しいプロジェクトの初期化 プロジェクトを初期化し、その後、以下のセクションで説明するようにFunctions、Client、AppSailアプリを初期化できます。 CLIから新しいプロジェクトを初期化するには： 1. ローカルマシンにプロジェクト用のフォルダを作成し、ターミナルからそこに移動します。そのディレクトリから以下のコマンドを実行してプロジェクトを初期化します： catalyst init 2. プロジェクトを作成する組織を選択します。Catalystでは複数の組織を作成して作業し、各組織でプロジェクトを作成できます。 3. 現在のプロジェクトディレクトリをこの組織内の既存のCatalystプロジェクトに関連付けることができます。また、CLIから直接新しいプロジェクトを作成するか、この組織内の既存のプロジェクトをインポートすることもできます。<br /> * この組織から既存のCatalystプロジェクトを選択するには、矢印キーを使用してプロジェクトリストから選択します。Enterを押して確定します。 注意: catalyst project:use コマンドを実行して、以前CLIで初期化した既存のプロジェクトを作業ディレクトリに関連付けることができます。 * 新しいプロジェクトを作成するには、Create a new projectオプションに移動してEnterを押します。Catalystコンソールにリダイレクトされ、新しいプロジェクトを作成できます。プロジェクト名を入力して**Create**をクリックします。 * 既存のプロジェクトをインポートするには、Import an existing projectを選択し、プロジェクトソースZIPファイルを選択する必要があります。これらの手順の詳細はエクスポートとインポートプロジェクトのヘルプページをご覧ください。 注意: * CLIから最初のCatalystプロジェクトを作成することはできません。最初のプロジェクトはCatalyst Webコンソールを使用してのみ作成できます。以降のプロジェクトはCLIから作成できます。 * アカウントで最大50個のプロジェクトを作成できます。この制限の引き上げをリクエストするには、support@zohocatalyst.comまでサポートにお問い合わせください。各リクエストはケースバイケースで対応いたします。 <br> 4. Spaceを押して機能を選択し、Catalystアプリケーションにセットアップするコンポーネントを選択します。Enterを押して選択を確定します。 以下のコンポーネントを初期化できます：Functions、Client、AppSail。<br /> <br> 注意: * コンポーネントを選択せずにプロジェクトを初期化することもできます。プロジェクト初期化の主な目的はディレクトリを特定のプロジェクトにバインドすることであるため、コンポーネントの初期化は必須ではありません。この場合、プロジェクトフォルダには catalyst.jsonと.catalystrcファイルのみが作成されます。 * プロジェクトの初期化時に特定のコンポーネントを初期化しなかった場合、プロジェクト初期化後いつでもセットアップできます。詳しくは、Clientのセットアップ、Functionsのセットアップ、AppSailの追加のヘルプセクションを参照してください。 <br> プロジェクトは一意のプロジェクトIDで作成されます。プロジェクトの詳細を含むcatalyst.json ファイルと.catalystrc隠しファイルがプロジェクトディレクトリに作成されます。 Catalystプロジェクトディレクトリには、初期化したすべてのコンポーネントに基づいたディレクトリ、ファイル、および依存関係が含まれます。以下の画像は、Java FunctionとBasic Clientコンポーネントがプロジェクトで初期化された場合のサンプルプロジェクトディレクトリを示しています。 注意: * 既存のプロジェクトディレクトリでリソースを初期化する場合、CLIはプロジェクトをディレクトリに関連付ける手順をスキップします。 * プロジェクトディレクトリにすでに存在するコンポーネントを初期化する場合、CLIはフォルダを上書きするかどうかを尋ねるメッセージを表示します。Yを押して既存のディレクトリを上書きするか、Nを押してディレクトリの作成をスキップし、Enterを押します。 * Enterを押すと、デフォルト値でクエリを自動入力できます。 * Visual Studio Code IDEユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してCLI操作を実行できます。Visual Studio Code IDEを使用してCatalystプロジェクトを初期化する手順はこちらをご覧ください。 -------------------------------------------------------------------------------- title: "Functionsの初期化" description: "CLIからCatalystプロジェクトおよびFunctions、Client、AppSailなどのプロジェクトリソースを初期化できます" last_updated: "2026-08-17T13:08:49.714Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/initialize-resources/initialize-functions/" service: "All Services" -------------------------------------------------------------------------------- # Functionsの初期化 ### Functionタイプのセットアップ プロジェクトのFunctionsディレクトリを初期化することを選択した場合、Catalystはセットアッププロセスを開始します。 1. 開発したいFunctionのタイプを選択します。選択してEnterを押します。<br /> Catalystで開発できる6つのタイプのFunctionは、Basic I/O、Advanced I/O、Event、Cron、Browser Logic、Integration、およびBrowser Logic Functionです。Functionタイプとその目的の詳細については、 **Functionsのヘルプページ** を参照してください。 <br> **Integration Functions:** <br> CLIの初期化プロセスは、Integration Functionsを除き、他のすべてのFunctionタイプで同じです。リストから_Integration_を選択した場合、次のステップに進む前に以下の2つの追加ステップを実行する必要があります：<br /> **i.** 統合するサービスを選択します。現在はCliq統合のみ選択できます。 **ii.** 必要なハンドラーを選択します。詳しくはIntegration Functionsのヘルプページをご覧ください。<br /> 残りのセットアッププロセスはすべてのFunctionタイプで同じです。プロセスはFunctionスタックによってのみ異なります。 注意: Cliq Integration Functionsは、EU、AU、IN、またはCAデータセンターからアクセスするCatalystユーザーには現在利用できません。ConvoKraft Integration Functionsはすべてのデータセンターで利用可能です。 <br> 2. サーバーサイドFunctionを開発するスタックを選択し、Enterを押します。リストにはサポートされているすべてのランタイムが表示されます。リストからJava、Node.js、またはPythonの最新サポートバージョンを選択できます。 注意: catalyst functions:add コマンドを使用して、単一のFunctionディレクトリ内に複数のJava、Node.jsまたはPython Functionを作成できます。 <br> ### 任意のタイプのJava Functionの初期化 1. Java Functionを初期化する場合、サポートされているランタイムから必要なランタイムを選択します：**Java 8**、**Java 11**、**Java 17**、**Java 21**、**Java 25**。 <br> 注意: Java Functionスタックのバージョンを選択する前に、システムに関連するJDKがインストールされていることを確認してください。以下のリンクから関連するJDKをインストールすることもできます： * Java 8 * Java 11 * Java 17 * Java 21 * Java 25 2. プロンプトが表示されたら、Java Functionの参照名を入力してEnterを押します。これはFunctionのフォルダ名にもなります。<br /> 3. Java Functionのメインクラス名を入力してEnterを押します。CLIはJava SDKパッケージをダウンロードし、Functionのセットアッププロセスを完了します。 <br> 4. **Java 11**、**Java 17**、**Java 21**、または**Java 25** Functionを初めて初期化する場合、システムにインストールされているJDKのパス情報を追加で設定する必要があります。この情報は、ローカルシステムに隠しファイルとして存在する特定の設定ファイルに設定できます。インストールされたJDKのパスは、config:set &lt;key=value&gt; CLIコマンドを使用して設定する必要があります。このコマンドの詳細については、このヘルプドキュメントをご覧ください。 以下の例に示すように、設定ファイルにパス情報を設定します： **Java 11**: catalyst config:set java11.bin=/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin <br /> **Java 17**: catalyst config:set java17.bin=/Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home/bin <br /> **Java 21**: catalyst config:set java21.bin=/Library/Java/JavaVirtualMachines/jdk-21.jdk/Contents/Home/bin <br /> **Java 25**: catalyst config:set java25.bin=/Library/Java/JavaVirtualMachines/jdk-25.jdk/Contents/Home/bin <br /> 注意: * 上記のコマンドに記載されているパスを、お使いのJDKパスに置き換えてください。 * ローカルシステムがWindows OSで動作している場合、パスをダブルクォーテーションで囲んでください。たとえば、Java 11のパスは次のように設定します：<br /> catalyst config:set java11.bin="/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin" <br /> Java Functionのフォルダは、メインの.javaクラスファイル、ライブラリJARファイル、catalyst-config.json、およびその他の設定ファイルで作成されます。これらの値は catalyst.json 設定ファイルで更新されます。<br /> Java Functionのディレクトリ構造の詳細については、プロジェクトディレクトリ構造のヘルプページをご覧ください。 <br> ### 任意のタイプのNode.js Functionの初期化 1. Node.js Functionを初期化する場合、サポートされているランタイムから必要なランタイムを選択します：**Node 24**、**Node 22**、**Node 20**、**Node 18**、**Node 16**、**Node 14**。 <br> 2. プロンプトが表示されたら、Node Functionのパッケージ名を入力してEnterを押します。<br /> 3. エントリーポイントファイルの名前を入力してEnterを押します。 4. Functionauthorの名前を入力してEnterを押します。 5. CLIはノード依存関係のインストールを許可するよう求めます。Yを押してインストールを確認し、Enterを押して選択を確定します。必要な依存関係をすべてインストールしないと、Function実行時にエラーが発生する可能性があります。<br /> CLIはNode.js SDKパッケージをダウンロードし、Functionのセットアッププロセスを完了します。<br> 注意: Catalystでは、Expressテンプレートで Advanced I/O Functionを作成でき、Express.jsモジュールがインストールされます。ただし、CLIからExpressテンプレートを作成することはできません。特定のFunctionのディレクトリから npm install express --save を実行して、Expressをシステムに個別にインストールし、Expressモジュールを使用できます。Expressテンプレートの詳細については、Advanced I/O Functionのヘルプページをご覧ください。 <br> Node Functionのディレクトリは、.jsメインFunctionファイル、catalyst-config.json、および依存関係をインストールした場合は必要なノードモジュールと設定ファイルでセットアップされます。これらの値は catalyst.json 設定ファイルで更新されます。 Node.js Functionのディレクトリ構造の詳細については、プロジェクトディレクトリ構造のヘルプページをご覧ください。 注意: * JavaまたはNode.js Functionのディレクトリには、任意の数のサブフォルダとファイルを追加できます。メインFunctionファイルに加えて、Functionのフォルダには他のサブFunctionを含めることができます。ただし、設定ファイルと依存関係はFunctionディレクトリのルートに配置する必要があります。 * Catalystコンソールを通じて、または外部エディターを使用してサブFunctionを作成できます。catalyst pullコマンドを使用して、コンソールから既存のFunctionディレクトリをローカルシステムにプルすることもできます。 * 複数のFunctionを初期化する必要がある場合、 catalyst functions:add コマンドを使用できます。 <br> ### 任意のタイプのPython Functionの初期化 1. Python Functionを初期化する場合、サポートされているランタイムから必要なランタイムを選択します：**Python 3.9**、**Python 3.10**、**Python 3.11**、**Python 3.12**、または**Python 3.13**。 2. プロンプトが表示されたら、Python Functionのパッケージ名を入力してEnterを押します。<br /> 3. エントリーポイントファイルの名前を入力してEnterを押します。 Python Functionの初期化が成功すると、Catalyst Python SDKパッケージがプロジェクトに自動的にインストールされ、requirements.txtファイルにエントリが追加されます。 注意: Python Functionを初めて初期化する場合、システムにインストールされているPythonのパス情報を追加で設定する必要があります。この情報は、ローカルシステムに隠しファイルとして存在する特定の設定ファイルに設定できます。パスはconfig:set &lt;key=value&gt; CLIコマンドを使用して設定する必要があります。このコマンドの詳細については、このヘルプドキュメントをご覧ください。 Python Functionのディレクトリは、.pyメインFunctionファイル、catalyst-config.json、およびrequirements.txt設定ファイルでセットアップされます。これらの値はcatalyst.json設定ファイルで更新されます。 Python Functionのディレクトリ構造の詳細については、プロジェクトディレクトリ構造のヘルプページをご覧ください。 初期化したFunctionをローカル環境でコーディングし、コンソールにデプロイできます。デプロイ前にFunctions shellを使用してテストとデバッグを行えます。同様に、localhostを通じて配信することもできます。 注意: * Java、Node.js、またはPython Functionのディレクトリには、任意の数のサブフォルダとファイルを追加できます。メインFunctionファイルに加えて、Functionのフォルダには他のサブFunctionを含めることができます。ただし、設定ファイルと依存関係はFunctionディレクトリのルートに配置する必要があります。 * Node.js FunctionのサブFunctionはCatalystコンソールを通じて作成できます。ただし、JavaおよびPython FunctionはCLIと外部エディターを使用してのみ作成・更新できます。 * catalyst pull コマンドを使用して、コンソールから既存のFunctionディレクトリをローカルシステムにプルできます。 * 複数のFunctionを初期化する必要がある場合、 catalyst functions:add コマンドを使用できます。 -------------------------------------------------------------------------------- title: "Clientの初期化" description: "CLIからCatalystプロジェクトおよびFunctions、Client、AppSailなどのプロジェクトリソースを初期化できます" last_updated: "2026-08-17T13:08:49.740Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/initialize-resources/initialize-client/" service: "All Services" -------------------------------------------------------------------------------- # Clientの初期化 ### はじめに Catalystでは、Web Client Hostingでホストできる3種類のネイティブクライアントアプリケーションを開発できます： * Angularアプリケーション * Reactアプリケーション * Basic Clientアプリケーション CatalystはAngularおよびReactクライアントアプリ用のすぐに使えるテンプレートを提供しています。これらのアプリを初期化すると、Catalystはセットアップ手順全体を処理し、必要な依存関係のインストールを求めます。AngularおよびReactアプリケーションは、ボイラープレート構造でプロジェクトディレクトリに作成されます。 Basic Clientアプリは、独自の標準構造で作成されるCatalystクライアントのシンプルなバージョンです。3種類のクライアントアプリすべてでインストール手順が異なります。 注意: * クライアントのディレクトリには、HTMLファイル、JavaScriptファイル、ロゴ画像など、任意の数のサブフォルダとファイルを追加できます。ただし、設定ファイルと依存関係はクライアントディレクトリのルートに配置する必要があります。 * catalyst pull コマンドを使用して、コンソールからローカルシステムにホストされたWebクライアントをプルすることもできます。 * Webクライアントホスティングは、基本的でシンプルなWebアプリケーションに適しています。Next.js、Angular、React、Vueなど、さまざまな人気のJavaScriptフレームワークでWebアプリケーションをシームレスにデプロイできる堅牢なフロントエンド開発サービスSlateをご利用いただけます。SlateはGitHub、GitLab、またはBitbucketからの自動デプロイメントも提供し、その他多くの高度な機能を備えています。 プロジェクトのクライアントディレクトリを初期化すると、CatalystはFunctionsの初期化後にセットアッププロセスを開始します。 オプションからプロジェクトに初期化するクライアントタイプを1つ選択し、Enterを押します。 <br> ### Angularアプリケーション Angularは、効率的で洗練されたシングルページアプリを作成するためのフロントエンドアプリケーション設計フレームワークおよび開発プラットフォームです。Angularはコンポーネントベースのアーキテクチャに従い、アプリは個々の再利用可能な機能的・論理的エンティティに分離されます。コンポーネント、テンプレート、ディレクティブ、依存性注入などのAngularの構成要素はモジュールに統合され、Angularアプリケーションを形成します。詳しくはAngular公式ドキュメントをご覧ください。 Angularクライアントアプリケーションの開発には、ローカルマシンにAngular CLIをインストールすることを推奨します。このCLIは必要な依存関係のインストールと設定を自動的に処理し、クライアントアプリケーションの開発とテストを容易にします。Catalystはクライアントの初期化プロセス中にインストールを自動的に開始します。 Catalystは、Angularアプリ用のプラグイン zcatalyst-cli-plugin-angular も提供しており、Angularアプリの初期化時にインストールされます。このプラグインは最新のAngular LTSバージョンと互換性があり、Angularアプリの開発とテストに関わるいくつかの操作を内部的に処理します。これによりアプリケーション構築タスクが簡素化・高速化され、セットアップとメンテナンスではなくアプリの機能に集中できます。 注意: Catalystプラグインは、特定のアプリケーションのディレクトリにインストールする必要があります。 catalyst.json 設定ファイルにプラグインのパスが指定されます。CatalystはAngularプラグインのグローバルインストールのサポートを廃止しました。既存のAngularアプリのコードを適宜更新してください。 <br> クライアントの初期化時にオプションからAngular Web Appを選択すると、CatalystはAngularアプリケーションの標準セットアップ手順を開始します。アプリは最新のLTSバージョンで作成されます。 注意: Catalystが現在サポートしているAngular LTSバージョンはv12です。 1. CLIはプロジェクトのクライアントコンポーネントの名前を入力するよう求めます。クライアント名を入力してEnterを押します。<br /> <br> 2. Angular CLIがシステムにまだインストールされていない場合、CatalystはそのLTSバージョンの一時的なインストールを自動的に開始します。また、Angularアプリを生成するために必要なCatalyst固有のスキーマティクスパッケージもインストールされます。<br /> <br /> プロンプトが表示されたら「Y」を入力して必要なパッケージのインストールを確認し、Enterを押します。<br /> 必要なパッケージがローカルシステムに既に存在する場合、セットアップは次のステップにスキップします。 注意: システムにインストールされているAngularのバージョンが古いか、サポートされていない場合、Catalystは最新のサポートバージョンに更新するよう求めます。 <br> 3. Angularルーティングを有効にして、作成するさまざまなビュー間のナビゲーションを処理できます。プロンプトが表示されたら「Y」を入力し、Enterを押します。<br /> <br> 4. 以下に示すサポートされているスタイルシート形式のいずれかでAngularコンポーネントをスタイリングできます。アプリのスタイルシート形式を選択し、Enterを押します。<br /> ルーティングとスタイルシートのプロンプトは、Angularアプリケーションのデフォルトセットアップ手順に含まれます。<br /> その後、CatalystはAngularアプリケーションファイル、設定ファイル、および依存関係のボイラープレート構造でのインストールを開始します。アプリの開発に必要なノードモジュールもNPMを通じてインストールされます。<br /> <br> 以下に示すように、Angularクライアントのディレクトリは、標準アプリケーションファイル、環境ファイル、プラグインファイル、スタイルシート、index.html、およびTypeScriptクラスでセットアップされます。必要なノードモジュール、JSON設定ファイル、およびCatalyst固有のclient-package.jsonを含む依存関係もディレクトリに存在します。 これらのパッケージがインストールされると、catalyst.json設定ファイルは、前述のプラグインファイルへのパスを含むクライアントパッケージの詳細で更新されます。Catalyst設定ファイルとクライアントディレクトリの詳細については、プロジェクトディレクトリ構造のヘルプページをご覧ください。 Catalyst CLIからAngularアプリのテストとデプロイについては、リソースの配信とリソースのデプロイのヘルプページをご覧ください。 <br> ### Reactアプリケーション Reactは、インタラクティブなアプリケーションとユーザーインターフェースを構築できるフロントエンドJavaScriptライブラリです。コンポーネントベースのアーキテクチャにより、ビルド時にアプリケーションの状態を効率的に管理およびレンダリングします。Reactはシングルページクライアントアプリケーションの開発における容易さと柔軟性を提供し、コンポーネントの再利用性を提供します。詳しくはReact公式ドキュメントをご覧ください。 Catalystは、Reactアプリ用のプラグインzcatalyst-cli-plugin-reactを提供しており、Reactアプリの初期化時にインストールされます。このプラグインには、Reactアプリの開発とテストに関わるいくつかの操作を内部的に処理する特定のノードモジュールとライブラリファイルが含まれています。これにより、より高速で効率的なアプリケーション構築プロセスが可能になります。 注意: Catalystプラグインは、特定のアプリケーションのディレクトリにインストールする必要があります。 catalyst.json 設定ファイルにプラグインのパスが指定されます。CatalystはReactプラグインのグローバルインストールのサポートを廃止しました。既存のReactアプリのコードを適宜更新してください。 Reactアプリを初期化すると、Catalystはデフォルトでyarnパッケージマネージャーを通じてアプリの作成と設定を自動的に行います。ローカルマシンにyarnがインストールされていない場合、ReactアプリはNPMを使用してセットアップされます。Catalystは、パッケージのリンクと解決、依存関係のインストールなど、すべての設定タスクをパッケージマネージャーを通じて自動的に処理します。 クライアントの初期化時にオプションからReact Web Appを選択すると、CatalystはReactアプリケーションの標準セットアップ手順を開始します。 1. 標準のJavaScriptテンプレートまたはTypeScriptテンプレートでReactアプリを作成できます。TypeScriptはJavaScriptの型付きスーパーセットで、コンパイル時にプレーンなJavaScriptにトランスパイルされます。Catalystは、セットアップ手順をより簡単で迅速にするために、初期化時にこれらのオプションを提供します。<br /> <br /> オプションからJavaScriptまたはTypeScriptを選択します。<br /> 2. CLIはプロジェクトのクライアントコンポーネントの名前を入力するよう求めます。クライアント名を入力してEnterを押します。 注意: AngularおよびBasic Webクライアントアプリケーションの場合、プロジェクト内のクライアントディレクトリはclientという名前になります。ただし、Reactアプリケーションの場合、クライアントディレクトリの名前は、初期化またはセットアップ時にここでWebクライアントに割り当てた名前と同じになります。たとえば、Webクライアントの名前を「vendorApp」とした場合、クライアントディレクトリもvendorAppという名前になります。この値はcatalyst.json設定ファイルで適宜更新されます。 これにより、Catalyst固有のCRAテンプレートを通じて、react、react-dom、react-scriptsなどの必要なReactパッケージのインストールが開始されます。このベーステンプレートは create-react-app コマンドを実行します。<br /> その後、パッケージマネージャーはReactアプリのgitリポジトリを初期化し、テンプレートの依存関係をインストールします。<br /> 初期化が完了すると、プロジェクトディレクトリにボイラープレート構造でReactアプリケーションファイルが作成されます。<br /> <br> 以下に示すように、Reactアプリのディレクトリ構造には、アプリケーションソースファイル、パブリックファイル、設定ファイル、ノードモジュール、およびCatalyst固有のclient-package.jsonを含むその他の依存関係が含まれます。 これらのパッケージがインストールされると、catalyst.json設定ファイルは、前述のプラグインファイルへのパスを含むクライアントパッケージの詳細で更新されます。Catalyst設定ファイルとクライアントディレクトリの詳細については、プロジェクトディレクトリ構造のヘルプページをご覧ください。 Reactアプリを配信またはデプロイすると、このディレクトリにReact.jsの標準に従ったコンパイル済みファイルを含むbuildフォルダが作成されます。 <br> ### Basic Clientアプリケーション Basic Clientアプリケーションは、外部フレームワークやライブラリなしで作成されるCatalystクライアントのシンプルなバージョンです。クライアントの初期化時にBasic Web Appオプションを選択して、シンプルで機能的なWebクライアントアプリケーションを作成できます。 CLIはプロジェクトのクライアントコンポーネントの名前を入力するよう求めます。クライアント名を入力してEnterを押します。 <br> クライアントディレクトリがプロジェクトのディレクトリに作成され、 catalyst.json ファイルがその情報で更新されます。 <br> Basic Clientのディレクトリは、メインのindex.htmlファイル、main.css、main.js、およびclient-package.json設定でセットアップされます。クライアントディレクトリ構造の詳細については、プロジェクトディレクトリ構造のヘルプページをご覧ください。 localhostを通じてクライアントを配信してテストし、その後クラウドにデプロイするか、コンソールから直接ホストできます。 -------------------------------------------------------------------------------- title: "AppSailサービスの初期化" description: "プロジェクトディレクトリにJava、Node.js、PythonのCatalystマネージドランタイム、またはOCIイメージとしてカスタムランタイムでCatalyst AppSail Webサービスを初期化し、クラウドにデプロイします。" last_updated: "2026-08-17T13:08:49.742Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/initialize-resources/initialize-appsail/" service: "All Services" -------------------------------------------------------------------------------- # AppSailの初期化 ### はじめに AppSailは、あらゆる規模のWebサービスをクラウドにデプロイし、そのプラットフォームインスタンスを管理できるCatalystのサーバーレスプラットフォームです。AppSailサービスは以下の2つの方法のいずれかで初期化できます： * Catalystマネージドランタイムとして：Catalystがサポートする特定のJava、Node.js、Pythonランタイムのアプリケーションを初期化し、リモートコンソールに直接デプロイします * コンテナイメージとして：任意のランタイムまたはフレームワークのアプリケーションのOCIイメージを、ローカルレジストリからリモートコンソールに初期化してデプロイします 注意: Catalystは、Linux AMD64（x86-64）プラットフォーム用にビルドされたOCI準拠のイメージのデプロイのみをサポートしています。 **詳細はこちらを参照してください。** どちらの場合も、デプロイ準備が整ったアプリのAppSailサービスを初期化し、このコマンドを通じてCatalystプロジェクトに関連付けることができます。 情報: appsail:addコマンドを使用して、既存のCatalystプロジェクトディレクトリをAppSailアプリに関連付けることができます。また、初期化なしでスタンドアロンコマンドを通じてアプリを直接デプロイすることもできます。 <br> ### CatalystマネージドランタイムとしてのAppSailの初期化 アプリのディレクトリまたは新しいディレクトリから、CatalystマネージドランタイムのAppSailサービスを直接初期化できます。プロジェクトの初期化時にAppSailを選択した場合、CatalystはClientの初期化後にセットアップを行います。 この方法でAppSailサービスが初期化されると、Catalystはapp-config.jsonファイルを作成します。 1. AppSailの初期化時に、CLIはランタイムタイプを**Catalyst-Managed Runtime**または**Docker Image**として選択するよう求めます。最初のオプションを選択します。 2. 「Y」を入力して**Enter**を押すことで、すぐに使えるサンプルプロジェクトから開始し、リストからサンプルアプリを選択できます。 サンプルアプリがディレクトリにダウンロードされます。プロンプトが表示されたら名前を入力します。 独自のアプリを初期化する場合は、「N」を入力して**Enter**を押します。 3. 「Y」を入力して、これがアプリのソースディレクトリであるかどうかを選択します。「N」を入力すると、CLIはディレクトリ内のアプリのソースの絶対パスを入力するよう求めます。入力後に**Enter**を押します。 4. アプリの名前を入力します。アプリのビルドのメインファイルには任意の名前を付けることができます。 注意: アプリをJava WARファイルとしてビルドする場合、メインファイルをroot.warと名付けるか、コードに応じて特定のコントローラーを追加する必要があります。 5. アプリの絶対ビルドパスを入力し、**Enter**を押します。 6. アプリのスタックとランタイムを選択し、**Enter**を押します。 Javaを選択すると、CLIはさらにアプリのデプロイ可能な形式として**Java SE**または**Java WAR**のいずれかを選択するよう求めます。詳しくはこちらをご覧ください。 他のスタックを選択した場合、このステップはスキップされます。 選択したソースディレクトリでAppSailが初期化され、アプリがCatalystプロジェクトに関連付けられました。設定はcatalyst.jsonファイルに適宜更新されます。 この初期化では、アプリのソースディレクトリにAppSail固有のapp-config.json設定ファイルのみが作成されます。デプロイ前に、このファイルのスタートアップコマンド、環境変数、メモリなどの値を編集できます。 <br> ### カスタムランタイムとしてのAppSailの初期化 新しいディレクトリから、アプリの準拠OCIイメージ用のAppSailを初期化できます。Catalystは、アプリのイメージをAppSailに関連付けるために使用できる2つのプロトコルをサポートしています。各プロトコルには、識別と機能のための固有のスキーマがあります。 * Docker Imageプロトコル: ローカルDockerレジストリに存在するアプリのビルド済みイメージを関連付けるために使用します。イメージはビルドされ、ローカルレジストリを指すようにタグ付けされている必要があります。例：*docker://localhost/expres-hw:latest* * Docker Archiveプロトコル: システムのディレクトリにあるアプリのビルド済みイメージのアーカイブファイル（.tarまたは.tar.gz）を指定するために使用します。例：*docker-archive://test.tar* 注意: .tarファイルは通常、docker saveコマンドで生成できます。 コンテナイメージの場合、AppSailの名前以外の詳細を提供する必要はありません。アプリのソースまたはビルドパス、スタック、スタートアップコマンドは、イメージ内ですでに定義されているため、OCIイメージでは設定する必要はありません。 1. AppSailの初期化時に、CLIはランタイムタイプをCatalyst-Managed Runtimeまたは**Docker Image**として選択するよう求めます。2番目のオプションを選択します。 2. プロトコルとして**Docker Image**または**Docker Archive**を選択します。 3. Docker Imageプロトコル: **Docker Image**を選択すると、CLIはローカルDockerレジストリ内の利用可能なすべてのイメージとタグを一覧表示します。必要なイメージを選択します。 Docker Archiveプロトコル: **Docker Archive**を選択すると、CLIはローカルシステム内のアプリのTARファイルイメージの絶対パスを入力するよう求めます。 注意: AppSailの設定がcatalyst.jsonファイルに保存される際、パスはそのファイルの場所を基準とした相対パスで保存されます。 4. AppSailサービスの名前を入力します。任意の名前を付けることができます。 ローカルディレクトリでAppSailが初期化され、アプリのイメージがAppSailサービスに関連付けられました。設定はcatalyst.jsonファイルに適宜更新されます。 注意: コンテナイメージでAppSailを初期化した場合、app-config.jsonファイルは作成されません。すべてのアプリの仕様はcatalyst.jsonファイルに保存されます。このファイルにアプリの特定のカスタム設定を追加できます。詳細はこちらを参照してください。 アプリにビジネスロジックをコーディングし、localhostを通じてAppSailサービスを配信してデバッグおよびテストするか、リモートコンソールに直接デプロイできます。 -------------------------------------------------------------------------------- title: "特定のリソースの初期化" description: "CLIからCatalystプロジェクトおよびFunctions、Client、AppSailなどのプロジェクトリソースを初期化できます" last_updated: "2026-08-17T13:08:49.743Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/initialize-resources/initialize-specific-resource/" service: "All Services" -------------------------------------------------------------------------------- # 特定のリソースの初期化 特定のリソースは以下の方法で初期化できます： catalyst init [feature] キーワードclient、appsail、またはfunctionsを入力する必要があります。たとえば、プロジェクトのFunctionsディレクトリのみを初期化するには、プロジェクトディレクトリから以下のコマンドを実行します： catalyst init functions -------------------------------------------------------------------------------- title: "初期化オプション" description: "CLIからCatalystプロジェクトおよびFunctions、Client、AppSailなどのプロジェクトリソースを初期化できます" last_updated: "2026-08-17T13:08:49.743Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/initialize-resources/initialize-options/" -------------------------------------------------------------------------------- # 初期化オプション ### -\-force Catalystでは、ディレクトリ内のプロジェクトまたはそのリソースを強制的に初期化できます。プロジェクトの初期化で問題が発生した場合、このオプションを使用できます。 プロジェクトの強制初期化を実行するには、以下のコマンドを実行します： catalyst init --force 前述と同じ手順に従ってリソースを初期化できます。 -------------------------------------------------------------------------------- title: "Slateの初期化" description: "CLIからプロジェクトリソースを初期化する際にCatalyst Slateサービスを初期化します。" last_updated: "2026-08-17T13:08:49.743Z" source: "https://docs.catalyst.zoho.com/ja/cli/v1/initialize-resources/initialize-slate/" -------------------------------------------------------------------------------- # Slateの初期化 # はじめに Slateは、Catalystが提供するフロントエンド開発サービスで、Webアプリケーションをシームレスにデプロイ、プレビュー、ローンチできます。Next.js、React、Angular、Astro、Vue、SolidJS、Svelte、Viteなどの人気のJavaScriptフレームワークのネイティブサポートを含め、任意のフロントエンドフレームワークで構築されたアプリケーションをデプロイできます。 サポートされているフレームワークの全リストを表示。 以降のセクションで説明する手順を使用して、プロジェクトディレクトリでSlateサービスを初期化できます。既存のプロジェクトディレクトリをCatalyst Slateにデプロイする場合は、まずcatalyst slate:linkコマンドを使用して、ディレクトリをSlateサービスにリンクする必要があります。必要に応じて、catalyst slate:unlinkコマンドを使用してリンクを解除することもできます。 さらに、catalyst slate:createコマンドを使用して、すでにSlateサービスが初期化されているプロジェクトディレクトリに複数のSlateアプリを追加できます。 Slateアプリのデプロイ方法を学ぶ。 ### Slateの初期化 アプリのディレクトリまたは新しいディレクトリから直接Slateサービスを初期化できます。プロジェクトの初期化時にSlateを選択した場合、以下の手順に従います： 以下のコマンドを使用してSlateサービスを直接初期化することもできます： catalyst init slate 1. Slateにデプロイするアプリケーションのクライアントフレームワークを選択します。Enterを押して確定します。 注意: このプロセスでは、選択したフレームワークに基づくボイラープレートテンプレートがプロジェクトディレクトリに自動的にダウンロードされ、カスタマイズしてSlateにデプロイできます。 2. CLIは、選択したフレームワークに基づいてSlateアプリケーションのデフォルト設定を行います。アプリケーションの名前を入力して**Enter**を押します。 この設定には、インストールコマンドとビルドコマンド、および各フレームワークのビルドパスが含まれます。デフォルト設定で進める場合はNを入力します。それ以外の場合はYを入力して必要な更新を行います。 注意: 1. インストールコマンドは、通常パッケージマネージャーを使用して必要な依存関係をインストールします。 2. ビルドコマンドは、開発コードを本番コードに変換するスクリプトです。 3. ビルドパスは、ビルドプロセスの実行後に本番環境用の最適化されたファイルが生成されるディレクトリです。 デフォルトでは、インストールコマンドは**npm install**、ビルドコマンドは**npm run build**として自動検出されます。これらを変更する場合は、Nを入力して必要なパッケージコマンドを指定できます。 設定を確認すると、選択したフレームワークのSlateテンプレートコードがプロジェクトディレクトリにダウンロードされ、プロジェクトディレクトリとCatalyst Slateサービスの接続として機能するcatalyst.jsonファイルにエントリが追加されます。 --- ## FAQ — Catalyst CLI # 一般 Catalyst CLIのインストールについては、**Catalyst CLIのインストールヘルプページ**を参照してください。 npmコマンドを使用してCatalyst CLIをインストールした後、ターミナルからCLIを操作できます。Catalystコマンドはキーワードcatalystで始まります。すべてのCLIコマンドの詳細については、**CLIドキュメント**を参照してください。 Catalyst CLIの新しいバージョンが利用可能な場合、CLIコマンドを正常に実行した後にターミナルにアラートメッセージが表示されます。 CLIを更新するには、以下のコマンドを実行します： $ npm install -g zcatalyst-cli 注意： - まれに、システムのレジストリ値がCatalyst CLIの最新バージョンを反映しない場合があります。その場合、システムが古いバージョンのCLIを保持する可能性があります。これを回避するには、コマンド実行時にバージョン番号を指定してください。例えば、バージョン1.14.1に更新するには $ npm install -g zcatalyst-cli @1.14.1 を実行します。 - Catalyst CLIを更新できない場合は、sudoを使用してコマンドを実行してください。 または、NPMウェブサイトにアクセスして、最新バージョンを使用しているか確認できます。 CLIで問題や異常な動作が検出された場合、Catalystはコマンドが実行されたディレクトリに自動的に<strong>catalyst-debug.log</strong>ファイルを作成します。その後、サポートメールアドレスsupport@zohocatalyst.comを通じてCatalystチームにお問い合わせいただけます。 問題の簡単な説明を記載し、メールにcatalyst-debug.logファイルを添付してください。Catalystチームが24時間以内に問題の解決策をご連絡いたします。 Catalyst CLIがローカルシステムに正しくインストールされていない場合、このエラーが発生する可能性があります。このエラーを修正するには、以下の手順を試してください： 1. ターミナルでnode -vコマンドを実行して、最新の安定版Nodeバージョンがインストールされているか、またv12より大きいかを確認する必要があります。 2. ターミナルでnpm -vコマンドを実行して、NPMバージョンがv12より大きいかも確認する必要があります。 3. Catalyst CLIをアンインストールし、macOSではsudoコマンドを使用して、またはWindowsでは管理者モードのコマンドプロンプトでCatalyst CLIを再インストールしてください。 Catalyst CLIは**Node.js v12以降**のみをサポートしています。このエラーが発生した場合、システムにインストールされているNode.jsのバージョンが古い可能性があります。 このエラーを解決するには、公式ウェブサイトからプラットフォーム用のNode.js v12以降をダウンロードしてNode.jsバージョンを更新するか、NVMなどのNodeバージョンマネージャーを使用してNode.jsとNPMをインストールします。NPMはNode.jsのインストール時にバンドルされています。Node.jsが正常に更新されたか確認するには、ターミナルで以下のコマンドを実行してバージョンを確認します： $ node -v システムで厳密なTLS認証が有効になっている場合、このエラーが発生します。ターミナルで以下のコマンドを実行することでこのエラーを解決できます： $ set NODE_TLS_REJECT_UNAUTHORIZED=0 これでCatalystコマンドの再実行を試すことができます。問題が解決しない場合は、support@zohocatalyst.comのCatalystサポートにお問い合わせください。 CLIは実行時にJavaクラスのみをコンパイルします。そのため、Java環境と使用しているjavacのバージョンが異なる場合、このエラーが発生します。 ターミナルで以下のコマンドを実行してJavaバージョンを確認できます： $ java -version 同様に、ターミナルで以下のコマンドを実行してjavacバージョンを確認できます： $ javac -version その他のご質問がある場合は、support@zohocatalyst.comのCatalystサポートにお問い合わせください。 # リソースの初期化 この問題は、別のアカウントのCatalystプロジェクトがすでに含まれているフォルダでプロジェクトを初期化しようとした場合に発生します。また、別のアカウントから以前にプロジェクトが初期化された場所の新しいフォルダでプロジェクトを初期化しようとした場合にも発生します。 例：この場所でプロジェクトを初期化すると仮定します：*C/windows/system32/catalyst/aliencity* catalyst、system32、またはwindowsという名前のフォルダのルートにすでにCatalystプロジェクトが初期化されている場合、このエラーが発生します。ただし、これらのディレクトリ内の独自のフォルダにプロジェクトを配置することは可能です。 この問題を解決するには、現在のフォルダおよびパス内の他のフォルダから、.catalystrcという名前の隠しファイルを含むすべてのCatalyst関連ファイルを削除してから、catalyst initコマンドを再度実行してください。 # リソースのサーブ catalyst serveの実行中にこのエラーが発生した場合、以下の方法で解決できます： * ターゲットをサーブする際に正しいフォルダパスにいることを確認してください。 * プロジェクトディレクトリが空でなく、サーブ可能なリソースが少なくとも1つ含まれていることを確認してください。CatalystはBasic I/OおよびAdvanced I/Oタイプのファンクションエンドポイント、クライアント、AppSailリソースをサーブできます。また、catalyst pullコマンドを使用して、サーブする前にCatalystコンソールからローカルシステムにリソースの最新コードをプルすることもできます。 Catalystはデフォルトでwatchモードでファンクションをサーブし、ホットコードリプレースメントを簡単に実行できるようにします。CLIコマンドcatalyst serve --no-watchを実行してno watchモードに切り替えることができます。 このエラーは、catalyst serveコマンドでファイル操作を実行した際に発生します。この問題を解決するには、ファイル関連の操作を行うローカルデバッグ時に、catalyst serveで--no-watchオプションを使用してください。--no-watchコマンドはホットモジュールリプレースメントを無効にします。 Catalystは現在、Java 8、Java 11、Java 17、Java 21、Java 25のバージョンをサポートしています。そのため、CLIでJavaファンクションをデバッグする前に、インストールされているjavaとjavacのバージョンが1.8.x、11.0.x、17.0.x、21.0.x、または25.0.xであることを確認する必要があります。 # CLI Functions Shell CLIでcatalyst shellコマンドを使用して、Cronファンクションをローカルで実行できます。JSON変数をCronファンクションへの入力として渡すことができます。Cronファンクションには、ローカルデバッグ中でもすべてのファンクション詳細を含む変数contextが含まれます。 Catalyst CLIでcatalyst shellコマンドを使用して、イベントファンクションをローカルで実行できます。catalyst event:generate {component} {action}コマンドを実行して、イベントファンクションのテスト用サンプルペイロードを生成できます。 例：catalyst event:generate DataStore insert。これにより、Data Storeの挿入操作用のサンプルペイロードが生成されます。生成されたペイロードをCLIでイベントファンクションへの入力として渡すことができます。 # リソースのデプロイ クライアントフォルダに500以上のファイルが存在する場合、このエラーが発生します。Catalyst Webクライアントで許可されるファイルの最大数は500です。