SPFx Toolkit

A CLI toolkit to help with SharePoint Framework (SPFx) project development, supporting both classic (gulp) and modern (Heft) build systems.

Features

• Add and clear shell aliases for the toolkit
• Build and bundle SPFx projects (auto-detects Gulp or Heft)
• Serve/start the SPFx dev server
• Backup and restore ESLint config
• Version management for SPFx projects

Installation

npm install -g @mschauer5/spfx-toolkit

Usage

After installation, run:

spfx-toolkit --help

Common Commands

• spfx-toolkit build — Build the project (auto-detects Gulp or Heft)
• spfx-toolkit bundle [--increment <part>] — Bundle the project (auto-detects Gulp or Heft, optionally increment version)
• spfx-toolkit serve — Start the SPFx dev server
• spfx-toolkit add-alias <name> — Add a shell alias for the toolkit
• spfx-toolkit clear-alias — Remove the shell alias for the toolkit
• spfx-toolkit run <name> — Run a script from package.json by name
• spfx-toolkit open-global-config — Open the global package.json for toolkit scripts in VS Code
• spfx-toolkit global-config-init [--force] — Initialize global package.json with default scripts (use --force to overwrite)
• spfx-toolkit sync-script <name> <global|local> — Sync a script name between global and local package.json
• spfx-toolkit open-solution — Open the solution folder in VS Code
• spfx-toolkit set-heft-dotenv-plugin — Installs and configures dotenv plugin for Heft
• spfx-toolkit eslint --backup|--restore — Backup or restore ESLint config
• spfx-toolkit version --list|--sync|--increment <part> — Version management

Example

spfx-toolkit build
spfx-toolkit bundle
spfx-toolkit serve
spfx-toolkit add-alias st
spfx-toolkit clear-alias

Requirements

• Node.js 18+
• For SPFx 1.22+ projects, Heft must be installed in your project
• For older SPFx projects, Gulp must be installed
• npm install -g @rushstack/heft to run heft commands from this tool

License

MIT

Disclaimer:

This software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

Developed by Matt Schauer