sf_cli 1.0.0.beta5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0d747d19bb4e6c437c2314d83d2e11e138b8f3e241a43a59556fa7fad0829f6
-  data.tar.gz: 9474614d2da8a4bf6b7bc297d81d3221b90a13a65dba0727c1aa8067418bf37b
+  metadata.gz: c83fc3297315182771f73c3ff599bfdd9abcff1c72a401d69bc8a734e9c7cd17
+  data.tar.gz: 8ed2425d43258abcc43e7ba9ec0dadf1cc18474d47ea286b38998b564cd68e6d
 SHA512:
-  metadata.gz: 951b09d44c48730ddb22fbe60b54b58179a4c5b34d42e2b374f5a68c291c1d5514dc735cd6a7585840cfaec1936d4b9187ab6846472d870142e502ddec1e8368
-  data.tar.gz: 4636eb0848036329af68fb63aec261e4eee191147d6c4327b4cc6ad4f4d516a8ae3c59239af0d969a0cbdc6ce6d8979e00984f90770167fe37e369bce2b3434c
+  metadata.gz: f97ab229a3000ac570e2d46ccaf393a6f64fd5717587449dede15c149286624b2b37356f7ef5bbe23772a8e8f14519d291b3addfab0114b5963c5831d7f3d604
+  data.tar.gz: fb431e461147f16d9a2bac7cf13970f011dc53d77f936dd09a60ed47b2b28259722c3457f435136bfae03673d4bb8df6099ff234852fd03d16c221cf284fe481

data/README.rdoc

@@ -63,3 +63,20 @@ With sf command:
 Doing the same thing independently:
   contact = Contact.select(:Id, :Name).where(Name: 'Akin Kristen').take
   contact.Name # Akin Kristen
+== Developer Console
+Developer console integrates both sf_cli's command methods and object model librry into IRB to make scripting easier in REPL.
+
+You can directly use sf_cli's command methods:
+  $ sf_cli
+  > sf.query "SELECT Id, Name FROM Case", target_org: :your_org
+
+Object Model is also available:
+  > use :your_org_name
+  > gen :Account, :Contact, :User  #=> generate 3 Object model classes
+  > acc = Account.find_by Name: 'Hoge Fuga'
+
+There are some other console commands:
+  > query "SELECT Id, Name, ... FROM BazBar__c" # just same as `sf data query` with human readable format
+  > apex "System.debug('abc');"                 # execute Apex code instantly
+
+Type `help` for the help of all console commands

data/lib/sf_cli/console/commands.rb

@@ -12,8 +12,6 @@ module SfCli
     module Commands
       def use(target_org)
         org_info = sf.org.display target_org: target_org
-        #sf.org.login_web target_org: target_org, instance_url: org_info.instance_url unless org_info.connected?
-
         conn = SfCli::Sf::Model::SfCommandConnection.new target_org: target_org, instance_url: org_info.instance_url
         conn.open unless org_info.connected?
 
@@ -59,11 +57,11 @@ module SfCli
       alias :gen  :generate
       alias :conn :connection
 
-      def help(command = nil)
+      def help
         conf.inspect_mode = false
         puts <<~HELP
           Available commands:
-            use   --- set current org. If you use your default org, this isn't needed.
+            use   --- set current org.
             gen   --- generate Object model classes
             query --- Query by SOQL with human readable format
             apex  --- run Apex code
@@ -74,14 +72,14 @@ module SfCli
               use target-org
 
               parameters:
-                targat-org --- Username or alias of the org you are going to use.
+                targat-org --- Username or alias of the org you are going to use. If you are not sure about them, check by `sf org list`.
 
             [gen]
               gen object-name, object-name, ...
               generate object-name, object-name, ...
 
               parameters:
-                object-name --- Comma separated Names. Symbol or String can be OK. At least 1 object name is required. 
+                object-name --- Comma separated Names. Symbol or String can be OK. At least 1 object name is required.
 
               example:
                 gen :Account, :Contact, :User

data/lib/sf_cli/sf/project/core.rb

@@ -9,6 +9,7 @@ module SfCli
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm command reference
     #
+    # @private :nodoc: just for developers
     module Project
       # @private :nodoc: just for developers
       class Core

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta5
+  version: 1.0.0
 platform: ruby
 authors:
 - Takanobu Maekawa