Salesforce DX 開発者ガイド
jSalesforce DX のユーザー名と組織
スクラッチ組織を作成するときに、CLI によってユーザー名が生成されます。ユーザー名はメールアドレスのようになります (例: test-wvkpnfm5z113@example.com)。スクラッチ組織に接続したり、スクラッチ組織を開いたりするのにパスワードは必要ありませんが、後から org generate password コマンドを使用して生成することができます。
デフォルトの組織には、開発中に最も接続する組織を設定することをお勧めします。最も簡単な設定方法は、Dev Hub 組織にログインするときに設定するか、スクラッチ組織を作成することです。また、config コマンドを使用することもできます。それぞれの場合に、--set-default-dev-hub または --set-default フラグを指定します。また、別名を作成して、組織のユーザー名を直観的でわかりやすい名前にすることもできます。組織に接続するすべての CLI コマンドでユーザー名または別名を区別せずに使用できます。
この例では、ログインして組織を認証するとき (この場合は Dev Hub 組織)、およびスクラッチ組織を作成するときにデフォルトの組織と別名を設定します。
1sf org login web --set-default-dev-hub --alias my-hub-org
2sf org create scratch --definition-file config/project-scratch-def.json --set-default --alias my-scratch-orgCLI コマンドで組織の接続が必要かどうかを確認するには、-h フラグを指定してそのフラグリストを参照します。コマンドで --target-dev-hub フラグを指定すると、Dev Hub 組織に接続されます。同様に、コマンドで --target-org を指定すると、スクラッチ組織や Sandbox などに接続されます。この例では、org create scratch に関するフラグリストとヘルプ情報が表示されます。
1sf org create scratch -h組織への接続に必要な CLI コマンドを実行する際に、ユーザー名を指定しなかった場合、デフォルトが使用されます。認証または作成済みのすべての組織を表示するには、org list を実行します。デフォルトの Dev Hub とスクラッチ組織は、左側に絵文字でマークされます。詳細は、末尾に表示されている凡例を参照してください。
いくつかの例を見てみましょう。この例では、デフォルトとして設定した組織にソースコードをリリースします。
1sf project deploy startデフォルト以外の組織を指定するには、--target-org を使用します。たとえば、別名 my-other-scratch-org でスクラッチ組織を作成したとします。これはデフォルトではありませんが、ソースをリリースする必要があります。
1sf project deploy start --target-org my-other-scratch-orgこの例は、スクラッチ組織の作成時に --target-dev-hub フラグを使用して、デフォルト以外の Dev Hub 組織を指定する方法を示しています。
1sf org create scratch --target-dev-hub jdoe@mydevhub.com --definition-file my-org-def.json --alias yet-another-scratch-orgデフォルト組織の設定についての詳細
すでにスクラッチ組織を作成している場合、プロジェクトディレクトリから config set コマンドを実行することでスクラッチ組織や別の組織をデフォルトとして設定できます。
1sf config set target-org test-wvkpnfm5z113@example.comこのコマンドでは、ローカルで値が設定されるため、現在のプロジェクトのみが対象となります。コンピューター上のすべてのプロジェクトにデフォルト組織を使用するには、--global フラグを指定します。このコマンドは任意のディレクトリから実行できます。グローバルデフォルトは、ローカルプロジェクトのデフォルトによって上書きされます。
1sf config set target-org test-wvkpnfm5z113@example.com --globalこのプロセスは、target-dev-hub 設定変数を使用することを除き、デフォルトの Dev Hub 組織を設定することに似ています。
1sf config set target-dev-hub jdoe@mydevhub.comconfig 変数の設定を解除するには、config unset コマンドを実行しま��。すべての Salesforce DX プロジェクトで設定を解除するには、--global フラグを使用します。
1sf config unset target-org --global定義済みのすべての設定変数を表示するには、config list を実行します。プロジェクトディレクトリから実行すると、ローカルの設定変数も表示されます。
1sf config list別名指定についての詳細
alias set コマンドを使用して作成済みのクラッチ組織に別名を設定するか、任意の組織に対して認証後に別名を設定します。任意の組織 (Dev Hub 組織、スクラッチ組織、本番組織、Sandbox 組織など) の別名を作成できます。そのため、組織のユーザー名を必要とするコマンドを発行する場合、簡単に思い出せる組織の別名を使用することで操作の時間を短縮できます。
1sf alias set my-scratch-org test-wvkpnfm5z113@example.comまた、別名を使用すると、デフォルトの組織を簡単に設定できます。実際のユーザー名ではなく別名を使用することで、config set を使用して target-org を設定する前述の例が理解しやすくなります。
1sf config set target-org my-scratch-org名前-値ペアをスペースで区切ることで、1 つのコマンドで複数の別名を設定できます。次の場合は、等号記号を使用する必要があります。
1sf alias set org1=<username> org2=<username>別名は一度に 1 つのユーザー名にのみ関連付けることができます。複数回設定する場合、別名は直近のユーザー名を指し示します。たとえば、次の 2 つのコマンドを実行すると、別名 my-org は test-wvkpnfm5z113@example.com に設定されます。
1sf alias set my-org test-blahdiblah@example.com
2sf alias set my-org test-wvkpnfm5z113@example.com設定したすべての別名を表示するには、次のいずれかのコマンドを使用します。
1sf alias list
2sf org list別名を削除するには、alias unset コマンドを使用します。
1sf alias unset my-orgすべての組織のリスト
認証した組織や作成した有効なスクラッチ組織のユーザー名と別名を表示するには、org list コマンドを使用します。
1sf org list
2
3 Type Alias Username Org ID Status Expires
4 ── ─────── ────────────── ───────────────────────────────────────────── ────────────────── ───────────────────── ──────────
5 D DevHub JulesDevHub jules@sf.com 00DB0001234c7jiMAA Connected
6 Sandbox jules@sf.com.jssandtwo 00D020012344XTiEAM Connected
7 O Scratch my-scratch-org test-qjrr9q5d13o8@example.com 00DMN0012342Gez2AE Active 2023-08-21
8
9Legend: D=Default DevHub, O=Default Org Use --all to see expired and deleted scratch orgs出力には、認証または作成した組織 (Dev Hub 組織、本番組織、スクラッチ組織、Sandbox 組織) がリストされます。テーブルには、組織の認証時に指定したユーザー名、別名、ID、および CLI で接続できるかどうかが表示されます。左側の絵文字は、デフォルトの組織または Dev Hub を示します。詳細は、一番下の凡例を参照してください。スクラッチ組織にも、有効期限日が表示されます。
スクラッチ組織の作成日、関連する DevHub 組織、全組織のインスタンス URL などの詳細情報を表示するには、--verbose フラグを使用します。
1sf org list --verbose無効なスクラッチ組織をリストから削除するには、--clean フラグを使用します。このコマンドは、何らかの処理を実行する前にユーザーに確認します。
1sf org list --clean