tyoshikawa1106のブログ

- Force.com Developer Blog -

SFDC:Salesforce CLI コマンドを試してみました - Part 12

Part 12。『run Commands』から続き。残りのコマンド数は多くないので今回が最後。

Salesforce Developers

run Commands

Salesforce Functionsを利用している組織で使えるコマンド。

run function

CloudEvent を関数に送信します。

// 関数を実行します。
sf run function --url http://path/to/function

// ペイロードと JSON 応答を使用して関数を実行します。
sf run function --url http://path/to/function --payload '@file.json' --structured

run function start

Salesforce functionを構築して実行します。

// 関数を構築して呼び出し元を開始する
sf run function start

// 特定の言語とポートを使用して呼び出し側を開始します
sf run function start --port 5000 --language javascript

run function start local

Salesforce functionsをローカルで構築して実行します。

// 関数を構築して呼び出し元を開始する
sf run function start local

// 特定の言語とポートを使用して呼び出し側を開始します
sf run function start local --port 5000 --language javascript

schema Commands

メタデータ ファイルを生成します。確認時点ではベータ版機能でした。GAになったら試します。

イメージ

sobject Commands

Salesforce オブジェクトと対話するためのコマンド。

sobject describe

標準オブジェクト、カスタム オブジェクト、またはツール API オブジェクトのメタデータを表示します。

// デフォルト組織の「Account」標準オブジェクトのメタデータを表示します。
sf sobject describe --sobject Account

// エイリアス「my-scratch-org」を使用して、組織内の「MyObject__c」カスタム オブジェクトのメタデータを表示します。
sf sobject describe --sobject MyObject__c --target-org my-scratch-org

// デフォルト組織の ApexCodeCoverage Tooling API オブジェクトのメタデータを表示します。
sf sobject describe --sobject ApexCodeCoverage --use-tooling-api


試してみました。情報量が多くて最初の方は見えなくなってました。ファイル書き込みとかもなさそうなので利用シーンが思いつかない印象。

sobject list

指定されたカテゴリのすべての Salesforce オブジェクトを一覧表示します。

// デフォルト組織内のすべてのオブジェクトをリストします。
sf sobject list --sobject all

// エイリアス「my-scratch-org」を持つ組織内のカスタム オブジェクトのみを一覧表示します。
sf sobject list --sobject custom --target-org my-scratch-org


試してみました。オブジェクトのAPI名で表示されました。

static-resource Commands

静的リソースに関するコマンドです。

static-resource generate

静的リソースを生成します。

// 現在のディレクトリに MyResource という静的リソースのメタデータ ファイルを生成します。
sf static-resource generate --name MyResource

// application/json の MIME タイプを指定します。
sf static-resource generate --name MyResource --type application/json

// 「force-app/main/default/staticresources」ディレクトリにリソース ファイルを生成します。
sf static-resource generate --name MyResource --output-dir force-app/main/default/staticresources


試してみました。一応作成はできました。

visualforce Commands

Visualforceに関するコマンド。こういうコマンドが用意されているということを知っておけば良さそう。

visualforce generate component

Visualforce コンポーネントを生成します。

// 現在のディレクトリに Visualforce コンポーネントのメタデータ ファイルを生成します。
sf visualforce generate component --name mycomponent --label mylabel

// ディレクトリ「force-app/main/default/components」にファイルを生成します。
sf visualforce generate component --name mycomponent --label mylabel --output-dir components

visualforce generate page

Visualforce ページを生成します。

// 現在のディレクトリに Visualforce ページのメタデータ ファイルを生成します。
sf visualforce generate page --name mypage --label mylabel

// ディレクトリ「force-app/main/default/pages」にファイルを生成します。
sf visualforce generate page --name mypage --label mylabel --output-dir pages

whoami Commands

自分自身または自分のアカウントに関する情報を表示するコマンド。現在はSalesforce Functions用のコマンドのみでした。

whoami functions

Salesforce Functions ログインに関する情報を表示します。

// アカウント情報を取得します。
sf whoami functions

// トークンを表示し、結果を JSON として出力します。
sf whoami functions --show-token --json

Part 12 のまとめ

『run Commands』『schema Commands』『sobject Commands』『static-resource Commands』『visualforce Commands』『whoami Commands』とチェックしました。基本こういうコマンドも用意されているぐらいで十分かなと思います。Part 1 〜 Part 12でSalesforce CLIのコマンドをひととおりチェックできました。後はより高度な使い方を勉強すれば開発プロセスの効率化に繋がるかなと思います。