SharePoint Framework: Tools and some important commands

NodeJS: like IIS, local JavaScript hosting engine, which hosts javascript from your local machine for providing testing your development locally.


Node package manager(NPM) pulls needed framework to code JavaScript components. Which replaces installation of sdk and reference to GAC.

NPM Command Description
npm install -g yo Install yo using npm
npm i –save jquery Install jQuery npm package
npm i –save jqueryui Install jQueryUI npm package
npm i -g tsd Install TypeScript definition manager
npm i office-ui-fabric-react –save Install the Office UI Fabric Component npm package


TypeScript Definition Manager (TSD) allows you to search and install type definitions for your project.

TypeScript Definition Command Description
tsd install jquery jqueryui –save TSD will install the type definitions into the /typings folder, where there are few other typings already available which was scaffolded by the Yeoman generator
tsd install combokeys –save  


Yeoman is centralized repo of templets. You can install a template using npm, but the yeoman is the one which extracts and execute that template.

Yeoman Command Description
yo @microsoft/sharepoint Create a new SharePoint Framework project


Gulp: Task management providing building and serving project solution

Gulp Command Description
gulp serve Provide connect-server functionality to build and preview web part
gulp package-solution


create the package in the current folder:
gulp serve –nobrowser


Execute the gulp task to start serving from localhost
gulp –ship This will build the minified assets required to upload to the CDN provider. The –ship indicates the build tool to build for distribution
gulp deploy-azure-storage Type the gulp task to deploy the assets to your storage account
gulp bundle –ship Package the client-side solution.
gulp package-solution –ship This will create the updated client-side solution package in the sharepoint\solution folder.


Launching code in Visual Studio Code from the Command Line:

code . Open the project folder in Visual Studio Code (Default language)
code . –Locale=en Open the project folder in Visual Studio Code (English language)

Leave a Reply

Your email address will not be published. Required fields are marked *