読者です 読者をやめる 読者になる 読者になる

tyoshikawa1106のブログ

- Force.com Developer Blog -

SFDC:Force.com CLI Getting Started

salesforce.com

何度か試したことがあったのですが、最近Force.com CLIについての記事を見つけたのでもう一度試してみました。

Force.com CLIのダウンロード

下記サイトからforceファイルをダウンロードできます。
f:id:tyoshikawa1106:20160621221627p:plain

Force.com CLI


こんな感じです。
f:id:tyoshikawa1106:20160621221736p:plain:w200


続いてホームディレクトリにtoolsフォルダを用意して、先程のforceファイルをフォルダ内に移動します。
f:id:tyoshikawa1106:20160621222024p:plain


ここまでできたら次のコマンドを実行してみます。Permission deniedエラーが発生すると思います。

$ cd ~/tools
$ ./force
-bash: ./force: Permission denied

f:id:tyoshikawa1106:20160621222329p:plain


この問題は次のコマンドで解決します。

$ chmod +x ./force

f:id:tyoshikawa1106:20160621222459p:plain


これでForce.com CLIの利用準備が整いました。ですがもう一つ問題が残っています。コマンド実行時に「$ ./force」というように「./」をつける必要があることです。以前調べた時は解決方法が分からず諦めたのですが、次の手順で解決できるそうです。


ホームディレクトリに「.bash_profile」ファイルが存在していると思います。
f:id:tyoshikawa1106:20160621223000p:plain

これを任意のテキストエディタで編集します。

$ cd
$ subl .bash_profile


ファイルの内容はそれぞれの環境毎に異なると思いますが次の一文を追加します。

export PATH=$PATH:~/tools

f:id:tyoshikawa1106:20160621223251p:plain


編集後、ファイルを保存したら次のコマンドを実行して設定を反映させます。

$ . ~/.bash_profile

f:id:tyoshikawa1106:20160621223426p:plain


これでどのディレクトリからでも「$ force」コマンドを実行できるようになります。
f:id:tyoshikawa1106:20160621224136p:plain


以上がForce.com CLIのダウンロード手順です。

Force.com CLIのコマンド一覧

apiversion

現在のAPIバージョンを表示します。

$ force apiversion

f:id:tyoshikawa1106:20160621225017p:plain

login

Salesforceにログインします。(※実行するとログインページが表示されます。)

// Production
$ force login

// Sandbox
$ force login -i=test

f:id:tyoshikawa1106:20160621225355p:plain

logout

Salesforceからログアウトします。

$ force logout -u=<username>

f:id:tyoshikawa1106:20160621225841p:plain

logins

ログイン済みのユーザ一覧を表示します。activeと表示されているのが操作中のユーザです。

$ force logins

f:id:tyoshikawa1106:20160621230233p:plain

active

activeユーザの確認と設定を行います。

// activeユーザの確認
$ force active
// active ユーザの設定
$ force active force active -a user@example.org
whoami

ログインユーザの情報を確認できます。
※表示される情報が多いので通常は「$ force active」で確認した方が良さそう。

$ force whoami

f:id:tyoshikawa1106:20160621235024p:plain

sobject

標準/カスタムオブジェクトの一覧確認と操作ができます。
※項目の作成などの操作も一応行えるみたいです。

$ force sobject list

f:id:tyoshikawa1106:20160622000706p:plain

bigobject

Big Objectを確認できみたいです。

$ force bigobject
field
$ force field list <object>

f:id:tyoshikawa1106:20160622001224p:plain

record

レコードの取得/作成/更新/削除などを行うことができます。

$ force record

f:id:tyoshikawa1106:20160622001436p:plain

force bulk

Bulk APIの操作を行うことができます。

$ force bulk

f:id:tyoshikawa1106:20160622001714p:plain


他にもいくつかコマンドが用意されていますが今回はここまで。

参考サイト

今回の記事を書くときに参考にしたサイトです。
f:id:tyoshikawa1106:20160621220539p:plain

Bob Buzzard Blog: Force CLI Part 1 - Getting Started

関連記事

昔調べて書いた時の記事です。