CLIコマンドリファレンス
Catalystコマンドにアクセスするには、システムにCatalyst CLIがインストールされている必要があります。手順については、Catalyst CLIのインストールのヘルプページを参照してください。
オプション
| コマンド構文 | 使用方法 |
|---|---|
| -v | –version | Catalyst CLIのバージョン番号を表示します |
| -p | –project <name_or_project_id> | コマンドに使用するCatalystプロジェクトを指定します |
| –org <org id> | コマンドに使用するCatalyst組織を指定します。-pオプションと併用します。 |
| –token <token> | コマンドの認証トークンを指定します |
| –dc <us|eu|in|jp|sa|au|ca> | コマンドのデータセンターを指定します |
| –verbose | デバッグ目的でログレベルをverboseに変更します |
| -h | –help | Catalystコマンドのヘルプを表示します |
コマンド
| コマンド構文 | 使用方法 |
|---|---|
| login [options] | CLIをCatalystアカウントにログインします |
| token:generate [options] | リモートシステムからCLIへのアクセスを認証するためのトークンを生成します |
| token:list | このCLIで生成されたすべての利用可能なトークンを一覧表示します |
| token:revoke <id> | このCLIで生成されたトークンを取り消します |
| whoami | 現在ログインしているユーザーのメールアドレスを表示します |
| init [feature] [options] | ローカルディレクトリでCatalystプロジェクト、関数、AppSail、クライアントリソースを初期化します |
| project:list | アクセス可能なすべてのCatalystプロジェクトを一覧表示します |
| project:use [name_or_project_id] | 作業ディレクトリにアクティブなCatalystプロジェクトを設定します |
| project:reset | アクティブなプロジェクトの選択をクリアし、ベースプロジェクトにリセットします |
| pull [feature] | リモートコンソールからローカルディレクトリにプロジェクトのリソースをプルします |
| iac:export [options] | プロジェクトのコードと設定をZIPファイルとしてエクスポートします |
| iac:import [options][file_path] | プロジェクトのZIPファイルをインポートし、コンソールに新しいプロジェクトを作成します |
| iac:pack [zip_name] | 標準形式でプロジェクトのインポート用ZIPファイルを生成します |
| iac:status [options]<operation> | スケジュールされたインポートまたはエクスポートジョブの現在のステータスを取得します |
| functions:setup | プロジェクトディレクトリで関数ディレクトリをセットアップおよび設定します |
| functions:add | 必要なスタックの関数を関数ディレクトリに追加します |
| functions:config [function_name_or_id] [options] | プロジェクト内の関数に対してメモリ割り当てなどの高度な設定を行います |
| functions:shell [options] | Advanced I/O関数以外の任意のスタックまたはタイプのエミュレートされた関数をテストするためのnode shellを起動します |
| functions:delete [function_name_or_id] [options] | リモートコンソールまたはローカルディレクトリから関数を削除します |
| config:set <key=value> | Catalystの設定をキーと値のペアとして設定します |
| config:get <key> | 指定されたキーのCatalyst設定値を取得します |
| config:list | すべてのCatalyst設定を一覧表示します |
| config:delete <key> | Catalyst設定からキーを削除します |
| appsail:add | 既存のCatalystプロジェクトディレクトリをAppSailサービスに関連付けます |
| client:setup | プロジェクトディレクトリでクライアントディレクトリをセットアップおよび設定します |
| client:delete [client_version] [options] | リモートコンソールまたはローカルディレクトリからクライアントのバージョンを削除します |
| ds:import [~CSV_file_path] [options] | Catalyst Data Storeのテーブルにレコードを一括書き込みします |
| ds:export [options] | Catalyst Data Storeのテーブルからレコードを一括読み取りします |
| ds:status <operation> [job_id] [options] | Data Storeのインポートまたはエクスポート操作のジョブステータスを表示します |
| apig:enable | プロジェクトのAPI Gatewayを有効にします |
| apig:disable | プロジェクトのAPI Gatewayを無効にします |
| apig:status [options] | プロジェクトのAPI Gatewayの現在のステータスとスケジュールの進行状況を取得します |
| event:generate | generate:event <source> <action> [options] | Event関数をテストするために、さまざまなコンポーネントまたはカスタムイベントソースからサンプルペイロードを生成します |
| event:generate:integ <service> [options] | Integration関数をテストするために、必要な統合サービスのサンプルペイロードを生成します |
| event:generate:job | Job関数をテストするためのサンプルペイロードを生成します |
| run-script | run [command] | catalyst.jsonで定義された特定のコマンドスクリプトを実行します |
| serve [options] | Basic I/O、Advanced I/O、BrowserLogic関数、AppSail、およびクライアントをローカルでテストするためにサーブします |
| deploy [options] [feature] | ローカルディレクトリからリモートコンソールにCatalystプロジェクトとプロジェクトリソースをデプロイします |
| help [command] | コマンドリファレンスまたは特定のコマンドのヘルプを表示します |
| logout | CLIをCatalystアカウントからログアウトします |
| codelib:install | 事前設定されたCatalyst CodeLibコンポーネントをプロジェクトにインストールします |
注意: Visual Studio Code IDEのユーザーの場合、Catalyst Tools拡張機能をインストールして、CLIの代わりにIDEを使用してこれらのCLI操作を実行できます。Catalyst VS Code拡張機能の詳細は、このヘルプセクションをご覧ください。
最終更新日 2026-02-23 18:09:41 +0530 IST
Yes
No
Thank you for your feedback!
Send your feedback to us
Skip
Submit