Salesforce DX 設定ガイド バージョン 41.0, Winter 18 @salesforcedocs 最終更新日 : 2017/10/13
本書の英語版と翻訳版で相違がある場合は英語版を優先するものとします Copyright 2000 2017 salesforce.com, inc. All rights reserved. Salesforce およびその他の名称や商標は salesforce.com, inc. の登録商標です 本ドキュメントに記載されたその他の商標は 各社に所有権があります
目次 第 1 章 : ご利用になる前に............................................. 1 第 2 章 : システム要件................................................ 2 第 3 章 : 組織での Dev Hub の有効化..................................... 4 第 4 章 : 第二世代パッケージの有効化 ( ベータ )............................ 5 第 5 章 : Salesforce DX ユーザの追加..................................... 6 第 6 章 : Salesforce CLI のインストール................................... 8 macos での CLI のインストール.......................................... 9 Windows での CLI のインストール......................................... 9 Windows 10 Subsystem for Linux での CLI のインストール...................... 9 npm を使用した CLI のインストール....................................... 11 インストールの確認.................................................. 11 第 7 章 : 会社のファイアウォールまたは Web プロキシの背後からの Salesforce CLI の使用......................................................... 12 第 8 章 : CLI バイナリおよびプラグインの更新............................ 13 第 9 章 : CLI バイナリまたはプラグインのアンインストール................. 14 第 10 章 : GitHub のサンプルソース..................................... 15 第 11 章 : 次のステップ............................................... 16
第 1 章 ご利用になる前に Salesforce DX の探索を開始する前に Salesforce DX 環境を設定する必要があります Salesforce DX ベータに参加していた場合は インストールの確認 の指示に従います これで完成です いつでも探索を開始できます 1. 本番組織 (Salesforce ユーザの場合 ) またはビジネス組織 (AppExchange パートナーの 場合 ) で Dev Hub を有効にします 最初に Salesforce DX を試す場合は Dev Hub が有効になっているトライアル組織にサインアップできます 2. 組織で第二世代パッケージ (2GP) を有効にして 2GP パッケージを開発できるよう にします 3. チームを含める場合は Dev Hub 組織にユーザを追加できます 4. コンピュータがすべてのシステム要件を満たしていることを確認します 5. Force.com IDE 2 ( ベータ ) または Visual Studio Code 向け Salesforce 開発ツールを評価する 場合は ダウンロードしてインストールします 6. GitHub から Salesforce DX サンプルをダウンロードします 関連トピック : Salesforce DX トライアル組織 Force.com IDE 2 開発者ガイド ( ベータ ) Visual Studio Code Extension Pack for Salesforce DX (Visual Studio Marketplace) 1
第 2 章 システム要件 Salesforce DX を最大限に活用するには 次のシステム要件のリストを確認してください オペレーティングシステム Salesforce CLI では 次のオペレーティングシステムがサポートされます Windows Windows 7 (64 および 32 ビット ) 以降 Mac macos 10.11 以降 Linux Ubuntu 14.0.4 macos の要件 : 開発者ツールセット Git を含む基本的な開発者ツールセットをインストールします これらのコマンドラインツールのインストールには Xcode 開発者パッケージ全体のインストールや開発者アカウントは必要ありません xcode-select --install 次のエラーメッセージは 表示されても無視して構いません このエラーは Xcode がすでにインストールされていることを意味します Can t install the software because it is not currently available from the Software Update server xcode-select: error: command line tools are already installed, use "Software Update" to install updates メモ : macos の新しいバージョンに更新する場合 このコマンドを再度実行します Windows の要件 : PowerShell Salesforce DX をインストールする各 Windows コンピュータに PowerShell ( バージョン 5.1 以降 ) をインストールします 2
システム要件 コードエディタまたは IDE Salesforce DX 用に構築され再設計された Force.com IDE など 任意のコードエディタを Salesforce DX で使用できます バージョン管理システム 任意のバージョン管理システム (VCS) を Salesforce DX で使用できます GitHub を使用して Salesforce の GitHub リポジトリにあるサンプルを利用することをお勧めします 関連トピック : Force.com IDE 2 開発者ガイド ( ベータ ) GitHub PowerShell ドキュメント 3
第 3 章 組織での Dev Hub の有効化 コマンドラインおよび Lightning Experience からスクラッチ組織を作成 管理できるように 組織の Dev Hub を有効にします スクラッチ組織は 開発とテストをサポートする破棄可能な Salesforce 組織です メモ : 本番組織またはビジネス組織での Dev Hub の有効化は完全に安全であり パフォーマンスの問題や顧客の問題が発生することはありません Dev Hub は ユーザと組織が使用可能なアクセスレベルをシステム管理者が制御できる権限を含むオブジェクトで構成されます 1. 本番組織 (Salesforce ユーザの場合 ) ビジネス組織 (ISV の場合 ) またはトライアル 組織に システム管理者としてログインします 2. [ 設定 ] から [ クイック検索 ] ボックスに Dev Hub と入力し [Dev Hub] を選択 します 3. Dev Hub を有効にするには [ 有効化 ] をクリックします Dev Hub は一度有効化すると 無効化できません トライアル組織を使用している場合 Dev Hub はすでに有効になっています 関連トピック : Salesforce DX トライアル組織 Salesforce DX ユーザの追加 4
第 4 章第二世代パッケージの有効化 ( ベータ ) 組織で第二世代パッケージ (2GP) を有効にして 2GP パッケージを開発できるようにします このパッケージは スクラッチ組織 Sandbox 組織 および対象登録者組織で使用できます 組織で Dev Hub を有効にします 1. Dev Hub を有効にした組織にログインします 2. [ 設定 ] から [ クイック検索 ] ボックスに Dev Hub と入力し [Dev Hub] を選択 します 3. [ 第二世代パッケージ ] のセクションで [ 非正式リリースのサービス契約に同意す るものとします ] をクリックしてサービス契約を読みます 4. 第二世代パッケージを有効にするには [ 有効化 ] をクリックします 第二世代パッケージは一度有効化すると 無効化できません 5
第 5 章 Salesforce DX ユーザの追加 システム管理者は デフォルトで Dev Hub にアクセスできます 他のユーザも Dev Hub にアクセスしてスクラッチ組織を作成できるようにすることができます Salesforce DX は Salesforce Salesforce Platform および Salesforce Limited Access - Free ( パートナーのみ ) の標準ユーザライセンスで使用できます システム管理者プロファイルでユーザを追加できます Salesforce DX に必要な権限セットを適用している場合 標準ユーザプロファイルでもユーザを追加できます Dev Hub 組織に追加するユーザは システム管理者の権限レベルが必要な場合以外はシステム管理者として追加しないでください 1. 必要に応じて ユーザを Dev Hub 組織に追加します a. [ 設定 ] から [ クイック検索 ] ボックスに ユーザ と入力し [ ユーザ ] を選択 します b. [ 新規ユーザ ] をクリックします c. フォームに入力し システム管理者または標準ユーザプロファイルを割り当 てます d. [ 保存 ] をクリックします システム管理者ユーザを追加する場合は これで終了です 2. 標準ユーザを追加する場合は Salesforce DX ユーザの権限セットを作成します ( 存 在しない場合 ) a. [ 設定 ] から [ クイック検索 ] ボックスに 権限セット と入力し [ 権限セット ] を選択します b. [ 新規 ] をクリックします c. 表示ラベル API 名 説明を入力します API 名は Force.com API および管理パッ ケージで使用される一意の名前です d. ユーザライセンスオプションを選択します この権限セットを異なるライセンスを持つ複数のユーザに割り当てる場合は [ なし ] を選択します e. [ 保存 ] をクリックします権限セット概要ページが表示されます このページから Salesforce DX に追加または変更する権限に移動できます 必要な権限については Salesforce DX ユーザの権限セット ( ページ 7) を参照してください 3. 標準ユーザに Salesforce DX 権限セットを適用します 6
Salesforce DX ユーザの追加 a. [ 設定 ] から [ クイック検索 ] ボックスに 権限セット と入力し [ 権限セット ] を選択します b. Salesforce DX 権限セットを選択します c. [ 権限セット ] ツールバーで [ 割り当ての管理 ] をクリックします d. [ 割り当てを追加 ] をクリックします e. 権限セットを割り当てるユーザを選択します f. [ 割り当て ] をクリックします g. [ 完了 ] をクリックします Salesforce DX ユーザの権限セット Dev Hub へのフルアクセス権を付与するには 権限セットに次の権限を含める必要があります [ オブジェクト設定 ] -> [ スクラッチ組織情報 ] -> [ 参照 ] [ 作成 ] [ 削除 ] [ オブジェクト設定 ] -> [ 有効なスクラッチ組織 ] -> [ 参照 ] [ 削除 ] [ オブジェクト設定 ] -> [ 名前空間レジストリ ] -> [ 参照 ] [ 作成 ] [ 削除 ] ユーザのアクセスを制限するには 権限を変更します 関連トピック : 権限セット (Salesforce ヘルプ ) Salesforce DX 開発者ガイド 7
第 6 章 Salesforce CLI のインストール トピック : macos での CLI のインストール CLI コマンドを使用して 開発環境とテスト環境を作成し スクラッチ組織とバージョン管理システム間でソースコードを同期し テストスイートを実行できます Windows での CLI のインストール npm を使用した CLI のインストール インストールの確 認 8
Salesforce CLI のインストール macos での CLI のインストール macos での CLI のインストール macos では.pkg ファイルを使用して Salesforce CLI をインストールします 1..pkg ファイルをダウンロードします 2..pkg ファイルをダブルクリックします 関連トピック : インストールの確認 Windows での CLI のインストール Windows では.exe ファイルを使用して Salesforce CLI をインストールします 1. Windows インストーラをダウンロードして実行します インストーラが Git を検出できない場合 Git もインストールされます 2. PATH 環境変数に Git バイナリの場所が含まれていることを確認します たとえば 次のように指定します set PATH=%PATH%;C:\Program Files\Git\bin 警告 : Salesforce CLI は ネイティブ Windows コマンドプロンプト (cmd.exe) および Microsoft Powershell 内で最適に動作します cygwin や MinGW などの Linux ターミナルエミュレータはバグのサポートが制限されているため これらのエミュレータで Salesforce CLI を使用することはお勧めしません 関連トピック : インストールの確認 Windows 10 Subsystem for Linux での CLI のインストール Windows Subsystem for Linux (WSL) では Windows 10 で従来の Windows デスクトップと共にネイティブ Linux コマンドラインツールを実行できます 1. [ ファイル名を指定して実行 ] ダイアログボックス (Windows キー + R) から optionalfeatures.exe を実行 します 2. [Windows の機能 ] で [Windows Subsystem for Linux] を選択します 9
Salesforce CLI のインストール Windows 10 Subsystem for Linux での CLI のインストール 3. コマンドプロンプトから bash と入力して Ubuntu のインストールを起動します プロンプトで y と入 力してコンポーネントをインストールすることに同意します > bash 4. Ubuntu のインストールが完了したら /mnt/c/programfileslinux ディレクトリを作成します $ mkdir /mnt/c/programfileslinux 5. その新しいディレクトリに移動します $ cd /mnt/c/programfileslinux 6. 最新の Linux (amd64) tarball のダウンロード URL を使用して wget を実行します 適切な URL については この マニフェストファイルを参照してください $ wget https://developer.salesforce.com/media/salesforce-cli/sfdx-v5.7.6-d42cf65-linux-amd64.tar.xz 7. コンテンツを解凍します $ tar xvf sfdx-v5.7.6-d42cf65-linux-amd64.tar.xz 8. sfdx ディレクトリに移動します $ cd sfdx 9. インストールスクリプトを実行します $./install 10. Git をインストールします $ sudo apt-get install git メモ : Salesforce CLI を正常に機能させるには Git をインストールする必要があります 10
Salesforce CLI のインストール npm を使用した CLI のインストール npm を使用した CLI のインストール コンピュータに Node.js をインストールしている場合 npm を使用して Salesforce CLI をインストールできます 1. コンピュータに Node v8.4.0 以降がインストールされていることを確認します たとえば macos または Linux で次のコマンドを実行します $ node --version v8.4.0 2. 次のコマンドを実行します $ npm install --global sfdx-cli 関連トピック : インストールの確認 npm ドキュメント インストールの確認 sfdx update コマンドを実行して Salesforce CLI のインストールを確認します $ sfdx update sfdx-cli: Updating CLI from 6.0.0-0743bea5 to 6.0.0-aebbfd66 (alpha)... done sfdx-cli: Updating CLI... already on latest version: 6.0.0-aebbfd66 sfdx-cli: Updating plugins... done 次のコマンドを実行して コアプラグインバージョンを確認します $ sfdx plugins --core salesforcedx 41.2.0 (core) 次のコマンドを実行すると force トピックのコマンドファミリのリストが返されます sfdx force --help 次のコマンドでは すべての force コマンドが返されます sfdx force:doc:commands:list 11
第 7 章 会社のファイアウォールまたは Web プロキシの背後からの Salesforce CLI の使用 会社のファイアウォールまたは Web プロキシの背後にあるコンピュータに Salesforce CLI をインストールすると エラーメッセージが表示される場合があります その場合は システムの詳細設定が必要です ファイアウォールまたは Web プロキシの背後で CLI バイナリをインストールした後に force --help を実行すると 次のようなエラーが表示されます これは Windows コンピュータでのエラーですが Linux および macos ユーザにも同様のエラーが表示される場合があります Installing required plugins for force...! Error installing package.! npm ERR! Windows_NT 6.1.7601! npm ERR! argv "C:\\Program Files\\SFDX\\lib\\node.exe" "C:\\Program Files\\SFDX\\lib\\npm\\cli.js" "install" "salesforcedx"! npm ERR! node v6.9.5! npm ERR! npm v3.10.10! npm ERR! error:0906d06c:pem routines:pem_read_bio:no start line! npm ERR!! npm ERR! If you need help, you may report this error at:! npm ERR! <https://github.com/npm/npm/issues>!! npm ERR! Please include the following file with any support request:! npm ERR! C:\Users\Admin\AppData\Local\sfdx\plugins\npm-debug.log この問題に対処するには ターミナルまたは Windows コマンドプロンプトから 次のコマンドの username:pwd を Web プロキシのユーザ名とパスワードに置き換えて実行します プロキシでこれらの値が不要な場合は省略します また proxy.company.com:8080 も会社のプロキシの URL とポートに置き換えます npm config set https-proxy https://username:pwd@proxy.company.com:8080 npm config set proxy https://username:pwd@proxy.company.com:8080 npm config set sslverify false npm config set strict-ssl false 次に HTTP_PROXY 環境変数をプロキシの完全な URL に設定します たとえば UNIX で次のコマンドを実行します export HTTP_PROXY=https://username:pwd@proxy.company.com:8080 12
第 8 章 CLI バイナリおよびプラグインの更新 CLI は CLI バイナリと Salesforce DX プラグインで構成されます CLI バイナリと Salesforce DX プラグインの両方が更新される場合と プラグインのみが更新される場合があります CLI バイナリと Salesforce DX プラグインを明示的に更新するには 次のコマンドを実行します sfdx update デフォルトでは CLI が定期的に更新を確認してインストールします 自動更新を無効にするには SFDX_AUTOUPDATE_DISABLE 環境変数を true に設定します export SFDX_AUTOUPDATE_DISABLE=true 13
第 9 章 CLI バイナリまたはプラグインのアンインストール CLI をアンインストールすると コンピュータから完全に削除されます macos または Linux ターミナルに次のすべてのコマンドを入力します sudo rm -rf /usr/local/sfdx sudo rm -rf /usr/local/lib/sfdx sudo rm -rf /usr/local/bin/sfdx sudo rm -rf ~/.local/share/sfdx ~/.config/sfdx ~/.cache/sfdx sudo rm -rf ~/Library/Caches/sfdx Windows 1. [ スタート ] > [ コントロールパネル ] > [ プログラム ] > [ プログラムと機能 ] を選択し ます 2. [SFDX CLI] を選択して [ アンインストール ] をクリックします 3. ホームディレクトリ内の.config\sfdx ディレクトリを削除します CLI がまだインストールされている場合は Program Files の %LOCALAPPDATA%\sfdx ディレクトリを削除します salesforcedx プラグインのアンインストール ターミナルまたは Windows コマンドプロンプトから次のコマンドを入力します sfdx plugins:uninstall salesforcedx 14
第 10 章 GitHub のサンプルソース Salesforce DX を探索しながら GitHub で Salesforce が提供するいくつかのサンプルリポジトリを確認することで 概念を理解するのに役立ちます sfdx-simple 2 つの Visualforce ページ コントローラ Apex テストが含まれる サンプル dreamhouse-sfdx 複数の Apex クラス 設定項目 Lightning コンポーネント Visualforce コンポーネント カスタムオブジェクトが含まれる より複雑なサンプル dreamhouse-sfdx サンプルはスタンドアロンアプリケーションです sfdx-travisci Salesforce DX を Travis CI と併用する方法を示す 継続的インテグレーション (CI) サンプル Travis CI は GitHub でホストされるソフトウェアプロジェクトを構築およびテストするために使用する クラウドベースの継続的インテグレーション (CI) サービスです 関連トピック : sfdx-simple GitHub サンプル dreamhouse-sfdx GitHub サンプル sfdx-travisci GitHub サンプル 15
第 11 章 次のステップ Salesforce CLI のインストール後に行う作業については 次の資料を読み進めてください DreamHouse サンプルを使用して Salesforce DX コンポーネントがどのように連携するかを実際に体験するには dreamhouse-sfdx Readme を参照してください Salesforce DX の使用方法についての詳細は Salesforce DX 開発者ガイド を参照してください CLI コマンドの完全なリストとその使用方法については Salesforce CLI コマンドリファレンス を参照してください 関連トピック : dreamhouse-sfdx GitHub サンプル Readme Salesforce CLI コマンドリファレンス Salesforce DX 開発者ガイド 16