CLIコンテキスト依存ヘルプ

はじめに

Catalystは、CLIコマンドの実行中にエラーが発生した場合にコンテキスト依存ヘルプを提供します。たとえば、コマンドの使用中に予期しないエラーが発生した場合や、コマンド実行中にリソースの取得中にエラーが発生した場合、Catalystはそのエラーの特定のコンテキストに対するヘルプを提供します。

コンテキストヘルプには、ユーザーによるコマンドの目的や使用方法の理解、およびエラー発生の原因の把握が含まれます。Catalystは状況を動的に分析して、期待される結果が得られない原因を特定し、それに応じてカスタマイズされたヘルプを提供します。

コマンド実行中に予期しないエラーが発生した場合、Catalystはエラーの原因を特定するだけでなく、エラーを修正または防止するために実行できるアクションのヘルプも提供します。Catalystは、特定のコマンドまたはアクションのドキュメントへのヘルプリンクも表示します。ヘルプリンクのURLをブラウザで開くだけで、ヘルプドキュメントにアクセスできます。

コンテキストヘルプの例

• catalyst client:delete [options] [client_version]コマンドを実行してクライアントのライブバージョンを削除しようとすると、CLIは現在ライブのクライアントは削除できないことを通知します。また、削除操作を再試行する前に、別のバージョンをライブにするか、クライアントの新しいバージョンをデプロイすることを提案します。詳細な説明を含むCLIドキュメントの特定のセクションへのヘルプリンクも提供されます。
  

• Catalystリモートアカウントからログアウトした状態でCLIコマンドを実行すると、CLIはコマンド実行の認証ができなかったことを通知します。アカウントにログインするか、有効な認証トークンを使用してコマンドを実行することを提案し、ヘルプリンクを提供します。
  

• 必要な設定ファイルが欠落した状態でリソースをデプロイすると、CLIは特定の欠落ファイルについて通知し、ディレクトリにそのファイルを含めることを提案します。提供されたヘルプリンクからプロジェクトディレクトリ構造について確認し、エラーを修正できます。