SFDX plugin for Angular apps deployment on Salesforce
Last updated a month ago by rzhigalov .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install sfdx-ngx-plugin 
SYNC missed versions from official npm registry.


SFDX plugin for Angular apps deployment on Salesforce

Version Downloads/week License

⚠️ This package is yet in beta version and may not work in all cases.
Please, create an issue if you encountered any issues


  1. SFDX
  2. Angular CLI


Install as plugin

sfdx plugins:install sfdx-ngx-plugin

Install from source

  1. Clone repository
  2. Open cloned folder
    cd path/to/cloned/repo
  3. Install npm modules
    npm install or yarn install
  4. Link the plugin
    sfdx plugins:link .


General flow

  1. Setup SFDX project e.g. sfdx force:project:create -n ProjectName --template standard)

  2. Create scratch org or configure persistent instance

  3. Initialize Angular project
    e.g. ng new my-shiny-metal-project

     * ⚠️ If you use routing in Angular app, than configure it to use URL fragment strategy
     * This is required as you can't override Salesforce routing resolution
    RouterModule.forRoot(ROUTES, {
       useHash: true,
  4. Run sfdx ngx:init and follow the prompts

  5. (optional) Configure vf.template.page with controller and Visualforce page appearance

  6. Run sfdx ngx:build

  7. Deploy code to Salesforce (sfdx force:source:deploy or sfdx force:source:push)


sfdx ngx:init`

Initializes files and settings for plugin

  $ sfdx ngx:init [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

  --json                                                                            format output as json
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command invocation

  $ sfdx ngx:init
    Starts plugin configuration wizard

sfdx ngx:build

Builds Angular project and packs for SFDC deployment

  $ sfdx ngx:build [-b <string>] [-m npm|yarn|pnpm] [-p <directory>] [--ngproject <directory>] [-t <directory>] [--sfdcpage <string>] [--sfdcresource <string>] [--apiversion <string>] [--json] [--loglevel

  -b, --buildcmd=buildcmd                                                           Angular build command
  -m, --packagemanager=(npm|yarn|pnpm)                                              Used package manager (npm, yarn, pnpm)
  -p, --ngpath=ngpath                                                               Relative path to Angular project (folder with angular.json)
  -t, --sfdcpath=sfdcpath                                                           Relative path to SFDC target dir
  --apiversion=apiversion                                                           SFDC API version
  --ngproject=ngproject                                                             Angular Project name
  --sfdcpage=sfdcpage                                                               SFDC Static Visualforce page name
  --sfdcresource=sfdcresource                                                       SFDC Static Resource name
  --json                                                                            format output as json
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for this command invocation

  # Uses initialized plugin settings
  $ sfdx ngx:build

       === Building Angular project for SFDC
       Creating Angular SFDC application... Done

       Angular project built and packed for SFDC deployment!

  # Flag overrides take precedence over plugin settings
  # After plugin will finish execution you will be offered to update plugin settings
  $ sfdx ngx:build
     -b build:sfdc (--buildcmd=build:commandname)
     -m yarn (--packagemanager=(npm|yarn|pnpm))
     -p client (--ngpath=relative/path/to/angular-app)
     -t forceApp/main/ngApp (--sfdcpath=relative/path/to/sfdc-folder)
     --apiversion 42.0
     --ngproject ng-app-name
     --sfdcpage PageName
     --sfdcresource StaticResourceName

Current Tags

  • 0.2.0-beta.6                                ...           latest (a month ago)

5 Versions

  • 0.2.0-beta.6                                ...           a month ago
  • 0.2.0-beta.5                                ...           a month ago
  • 0.2.0-beta.3                                ...           a month ago
  • 0.2.0-beta.2                                ...           a month ago
  • 0.2.0-beta.1                                ...           a month ago
Maintainers (1)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependents (0)

Copyright 2014 - 2017 © taobao.org |