Updating Docs & Cleaning up Code for next release

Author: manifestinteractive

README.md

@@ -5,9 +5,7 @@ SFCC CLI
 
 > Command Line Interface for Salesforce Commerce Cloud Sandbox Development
 
-![demo](https://sfcc-cli.s3.amazonaws.com/log.gif)
-![demo](https://sfcc-cli.s3.amazonaws.com/remote.gif)
-![demo](https://sfcc-cli.s3.amazonaws.com/watch.gif)
+![demo](https://sfcc-cli.s3.amazonaws.com/demo.gif)
 
 
 Introduction
@@ -19,7 +17,7 @@ Make developing for Salesforce Commerce Cloud work with any IDE on MacOS, Window
 - [X] Watch for code changes and upload in background ( without being prompted for passwords )
 - [X] Support for Eclipse Build Processes
 - [X] Log Viewing with Advanced Search & Filter Capabilities
-- [X] Sandbox Storefront "Remote Control"
+- [X] SFCC CLI integration via [Browser Extension](https://github.com/redvanworkshop/sfcc-remote)
 
 
 Developer Overview
@@ -44,20 +42,20 @@ Developer Overview
 Install
 ---
 
-#### Install via Clone
+#### Install via NPM
 
 ```bash
-cd ~
-git clone https://github.com/redvanworkshop/sfcc-cli.git
-cd sfcc-cli
-npm install -g --no-optional
+npm install -g sfcc-cli --no-optional
 sfcc setup
 ```
 
-#### Install via NPM
+#### Install via Clone
 
 ```bash
-npm install -g sfcc-cli --no-optional
+cd ~
+git clone https://github.com/redvanworkshop/sfcc-cli.git
+cd sfcc-cli
+npm install -g --no-optional
 sfcc setup
 ```
 

bin/cli.js

@@ -113,10 +113,16 @@ const argv = yargs
     }
   })
   .command('remote [client] [instance]', 'Enable Support for Browser Extension')
+  .example('sfcc setup', 'Setup SFCC Development')
+  .example('sfcc list', 'List Configured SFCC Clients')
   .example('sfcc delete my-client sandbox', 'Delete my-client sandbox config')
   .example('sfcc watch my-client sandbox', 'Watch for my-client sandbox changes')
   .example('sfcc log -i customerror --latest', 'Watch Latest Custom Error Logs')
   .example('sfcc remote', 'Live Reload Sandbox Storefront on Changes')
+  .example(' ', ' ')
+  .example('----------------------------------', '------------------------------------------')
+  .example('NEED MORE HELP ?', 'https://bit.ly/sfcc-cli-help')
+  .example('----------------------------------', '------------------------------------------')
   .demand(1)
   .help()
   .version().argv

commands/setup.js

@@ -5,8 +5,8 @@ const path = require('path')
 const prompt = require('prompt')
 const slug = require('slug')
 
-const config = require('../lib/config')()
 const builds = require('../lib/builds')
+const config = require('../lib/config')()
 
 module.exports = async () => {
   const setDefaults =

docs/cmd-remote.md

@@ -5,54 +5,32 @@
 `sfcc remote`
 ---
 
-> Remote Control for your Sandbox Storefront
+> Connect to SFCC CLI via Browser Extension
 
 ![demo](https://sfcc-cli.s3.amazonaws.com/remote.gif)
 
-If you only have a single project, you can run:
 
-```bash
-sfcc remote
-```
-
-If needed to setup multiple clients, or multiple instances for the same client, you will need to specify what to use:
-
-```bash
-sfcc remote <client> <instance>
-```
-
-**FLAGS:**
-
-Name        | Param           | Default | Definition
-------------|-----------------|---------|----------------------------------------------
-Live Reload | `--live-reload` | `false` | Enable Live Reload on Code Change
-
-
-Live Reload
+Browser Extension Setup
 ---
 
-This option is uses in conjunction with `sfcc watch` and when an upload is completed to your sandbox, a message is sent to to the page that it needs to refresh the page.  There is a slight delay to prevent multuple reloads, in the event that you have a build process that was kicked off in the background.
-
-To enable support for this, you need to make sure to install and setup the [rvw_devtools](https://github.com/redvanworkshop/rvw_devtools) cartridge on your sandbox.
+To get started, you'll need to [Install the Browser Extension](https://github.com/redvanworkshop/sfcc-remote).
 
-This will inject the following HTML snippet into your sandbox:
-
-```html
-<script src="https://localhost:8443/sfcc-cli-remote.js" id="sfcc-cli-remote"></script>
-```
-
-Once this is complete, you should only need to run the following command:
+Once you have the browser extension installed, you will need to do the following:
 
 ```bash
-sfcc remote <client> <instance> --live-reload
+sfcc remote
 ```
 
+Once the remote is turned on, all your `sfcc log` and `sfcc watch` output will be pushed to the browser extension.
 
 SSL Certificates
 ---
 
 In order for the SSL certificates to work locally, you will need to add the certificate to your system keys.
 
+<details><summary>VIEW INSTRUCTIONS</summary>
+<p>
+
 For MacOS you can do this:
 
 ```bash
@@ -68,3 +46,6 @@ openssl req -x509 -newkey rsa:2048 -out sfcc-cli-ca.cer -outform PEM -keyout sfc
 openssl req -newkey rsa:2048 -keyout sfcc-cli-localhost.pvk -out sfcc-cli-localhost.req -subj /CN=localhost -sha256 -nodes
 openssl x509 -req -CA sfcc-cli-ca.cer -CAkey sfcc-cli-ca.pvk -in sfcc-cli-localhost.req -out sfcc-cli-localhost.cer -days 10000 -extfile sfcc-cli.ext -sha256 -set_serial 0x1111
 ```
+
+</p>
+</details>

docs/cmd-setup.md

@@ -26,9 +26,11 @@ otherwise:
 #### Pass Params via CLI
 
 ```bash
-sfcc setup -c "My Client" -h dev04-web-mysandbox.demandware.net -d /Users/RVW/Projects/mysandbox -u [email protected] -p "my^pass"
+sfcc setup -c "My Client" -h dev04-web-mysandbox.demandware.net -d /Users/RVW/Projects/mysandbox -u [email protected] -p 'my^pass'
 ```
 
+NOTE: When using the password flag, make sure to wrap the text with SINGLE QUOTES.  Using Double Quotes will cause issues with passwords that contain dollar signs.
+
 **FLAGS:**
 
 Name           | Param | Required | Default   | Definition