Salesforce DX 開発者ガイド
jSalesforce DX のユーザ名と組織
スクラッチ組織を作成するときに、CLI によってユーザ名が生成されます。ユーザ名はメールアドレスのようになります (例: test-wvkpnfm5z113@example.com)。スクラッチ組織に接続またはスクラッチ組織を開くのにパスワードは必要ありませんが、後で force:user:password:generate コマンドを使用して生成できます。
Salesforce では、開発中に最も頻繁に接続する組織のデフォルトのユーザ名を設定することをお勧めします。この作業は、Dev Hub 組織の認証時かスクラッチ組織の作成時に行うのが最も簡単です。プロジェクトディレクトリからそれぞれ --setdefaultdevhubusername または --setdefaultusername パラメータを指定します。別名を作成して、ユーザ名により読みやすい名前を付けることもできます。組織に接続するすべての CLI コマンドでユーザ名または別名を区別せずに使用できます。
この例では、組織の認証時とスクラッチ組織の作成時にデフォルトのユーザ名と別名を設定します。
1sfdx force:auth:web:login --setdefaultdevhubusername --setalias my-hub-org
2sfdx force:org:create --definitionfile my-org-def.json --setdefaultusername --setalias my-scratch-orgCLI コマンドで組織の接続が必要かどうかを確認するには、--help パラメータを指定してそのパラメータリストを参照します。コマンドで --targetdevhubusername パラメータを指定すると、Dev Hub 組織に接続されます。同様に、コマンドで --targetusername を指定すると、スクラッチ組織や Sandbox などに接続されます。この例では、force:org:create に関するパラメータリストとヘルプ情報が表示されます。
1sfdx force:org:create --help組織の接続を必要とする CLI コマンドを実行する場合、ユーザ名を指定しないと、コマンドではデフォルトが使用されます。デフォルトのユーザ名を確認するには、force:org:list を実行して、認証または作成したすべての組織を表示します。デフォルトの Dev Hub 組織とスクラッチ組織の左側には、それぞれ (D) と (U) のマークが付きます。
いくつかの例を実行して、どのように機能するのかを確認しましょう。この例では、デフォルトとして設定したスクラッチ組織にソースコードを転送します。
1sfdx force:source:pushデフォルト以外の組織を指定するには、--targetusername を使用します。たとえば、別名 my-other-scratch-org で別のスクラッチ組織を作成したとします。これはデフォルトではありませんが、ソースを転送したいと考えています。
1sfdx force:source:push --targetusername my-other-scratch-orgこの例では、スクラッチ組織の作成時に --targetdevhubusername パラメータを使用して、デフォルト以外の Dev Hub 組織を指定する方法を示します。
1sfdx force:org:create --targetdevhubusername jdoe@mydevhub.com --definitionfile my-org-def.json --setalias yet-another-scratch-orgデフォルトのユーザ名の設定についての詳細
すでにスクラッチ組織を作成している場合、プロジェクトディレクトリから force:config:set コマンドでデフォルトのユーザ名を設定できます。
1sfdx force:config:set defaultusername=test-wvkpnfm5z113@example.comこのコマンドでは、ローカルで値が設定されるため、現在のプロジェクトのみが対象となります。コンピュータ上のすべてのプロジェクトにデフォルトのユーザ名を使用するには、--global パラメータを指定します。このコマンドは任意のディレクトリから実行できます。グローバルデフォルトは、ローカルプロジェクトのデフォルトによって上書きされます。
1sfdx force:config:set defaultusername=test-wvkpnfm5z113@example.com --globalこのプロセスは、defaultdevhubusername 設定値を使用することを除き、デフォルトの Dev Hub 組織を設定することに似ています。
1sfdx force:config:set defaultdevhubusername=jdoe@mydevhub.com別名指定についての詳細
組織の認証後に force:alias:set コマンドを使用して組織の別名を設定します。任意の組織 (Dev Hub 組織、スクラッチ組織、本番組織、Sandbox 組織など) の別名を作成できます。そのため、組織のユーザ名を必要とするコマンドを発行する場合、簡単に思い出せる組織の別名を使用して時間を短縮できます。
1sfdx force:alias:set my-scratch-org=test-wvkpnfm5z113@example.comまた、別名を使用すると、デフォルトのユーザ名を簡単に設定できます。ユーザ名ではなく別名を使用すると、force:config:set を使用して defaultusername を設定する前の例が大幅にわかりやすくなります。
1sfdx force:config:set defaultusername=my-scratch-org名前-値ペアをスペースで区切って、1 つのコマンドで複数の別名を設定します。
1sfdx force:alias:set org1=<username> org2=<username>別名は一度に 1 つのユーザ名にのみ関連付けることができます。複数回設定する場合、別名は直近のユーザ名を指し示します。たとえば、次の 2 つのコマンドを実行すると、別名 my-org は test-ymmlqf29req5@your_company.net に設定されます。
1sfdx force:alias:set my-org=test-blahdiblah@whoanellie.net
2sfdx force:alias:set my-org=test-wvkpnfm5z113@example.com設定したすべての別名を表示するには、次のいずれかのコマンドを使用します。
1sfdx force:alias:list
2sfdx force:org:list別名を削除するには、何も設定しません。
1sfdx force:alias:set my-org=すべての組織のリスト
認証した組織や作成した有効なスクラッチ組織のユーザ名を表示するには、force:org:list コマンドを使用します。
1sfdx force:org:list
2=== Orgs
3 ALIAS USERNAME ORG ID CONNECTED STATUS
4 ----------- -------------------- -------- ----------------
5 DD-ORG jdoe@dd-204.com 00D...OEA Connected
6(D) devhuborg jdoe@mydevhub.com 00D...MAC Connected
7
8
9 ALIAS SCRATCH ORG NAME USERNAME ORG ID EXPIRATION DATE
10 ---------- ------------ -------------------------- --------- ----------
11 my-scratch Your Company test-wvkm5z113@example.com 00D...UAI 2017-06-13
12(U) scratch208 Your Company test-wvkm5z113@example.com 00D...UAY 2017-06-13出力の上部のセクションには、認証したスクラッチ組織以外の組織 (Dev Hub 組織、本番組織、Sandbox 組織) がリストされます。出力には、組織の認証時に指定したユーザ名、別名、ID、および CLI で接続できるかどうかが表示されます。左側の (D) は、Dev Hub 組織のデフォルトのユーザ名を示します。
下部のセクションには、作成した有効なスクラッチ組織とそれらのユーザ名、組織 ID、有効期限がリストされます。左側の (U) は、スクラッチ組織のデフォルトのユーザ名を示します。
スクラッチ組織の詳細 (作成日、インスタンス URL、関連付けられている Dev Hub 組織など) を表示するには、--verbose パラメータを使用します。
1sfdx force:org:list --verbose無効なスクラッチ組織をリストから削除するには、--clean パラメータを使用します。このコマンドは、何らかの処理を実行する前にユーザに確認します。
1sfdx force:org:list --clean