Generator for platform.

Usage no npm install needed!

<script type="module">
  import generatorForce from '';


generator-force NPM version Build Status Dependency Status Coverage Status


First, install Yeoman and generator-force using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-force

Now clone your project or make a new folder and cd to it. Next setup your project

yo force

This will ask a few questions to set up your user and org for retrieve and deploy

  • project name (defaults to folder name)
  • sandbox (defaults to false)
  • username (username for your dev org)
  • password (password + secToken)
  • repo (optional setup for package.json github)

That's it your done

You have just setup your project with yo force. Now lets look at the commands you have.

yo force:retrieve 'optional package name'

NOTE: With out the package name yo force will assume you have a src/package.xml file and will retrieve based on it's contents.

yo force:deploy

New salesforce-lightning-cli added by default /src/aura.

Now each project gets setup with the custom rules from the cli tool and will run a default lint before deploy. But you can run a lint manually also. This will scan src/aura/*/.js files

npm run lint

S.P.A. Setup

Now lets create a new spa and generate your new project/spa/spaName:

yo force:ng 'spaName'

This will create a folder inside of the spa folder with the name of your spa, cd and npm install your dependencies

Now your Project folder structure should look like this (if you named the spa spaName)

│   package.xml    
│   src (sfdc: class, page, trigger)
    │   package.json
    │   webpack.config.js
    │   ...

Now get to work!

npm start

To push your spa / static resource use

npm run deploy

This will push a non minified version of your spa and meta to the org.

npm run production

This will push a minified version of your spa and meta to the org.

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced. Feel free to learn more about him.


MIT © Matt Newell