Skip to content

Requirements

pete-mc edited this page Jul 9, 2026 · 15 revisions

Getting Started

This guide takes you from a clean machine to a connected Dataverse project.

Steps: Install prerequisitesCheck requirementsInitialise a projectConnect.


Step 1 — Install the prerequisites

Dataverse PowerTools shells out to standard, cross-platform tooling. Install:

Tool Used for Install
.NET SDK Building plugins (targets .NET Framework 4.6.2 via reference assemblies, on any OS) dotnet.microsoft.com
Node.js Web resource build / bundling nodejs.org
Power Platform CLI (pac) Solution, portal and early-bound operations MS Learn install guide

Web resource projects also use a few globally-installed npm packages:

npm i -g jest webpack webpack-cli typescript

You don't have to install these by hand — the extension detects what's missing and offers to install them (next step).

Cross-platform: the extension runs on Windows, macOS, and Linux. Two features are Windows-only because they wrap Windows binaries: web resource typings (via XrmDefinitelyTyped.exe) and the deprecated pre-v3 (spkl) plugin path. Everything else — solutions, plugin build/deploy, web resource build/deploy — is cross-platform.

Recommended VS Code extensions

  • C# — plugin editing/debugging
  • ESLint — web resource linting
  • Jest — web resource tests

Step 2 — Check the System Requirements panel

Open the Dataverse PowerTools activity-bar view and expand System Requirements. It scans for the .NET SDK, Node.js, pac, and the required npm globals and shows ✅/❌ for each.

  • Add Missing npm Globals — installs any missing npm packages for you.
  • Recheck Requirements — re-runs the scan after you install something.

Verify: every row shows ✅ before you build or deploy.


Step 3 — Initialise a project

  1. Open an empty folder in VS Code (File → Open Folder).
  2. Run Dataverse PowerTools: Initialise Project from the Command Palette, or click Initialise Project in the activity-bar view.
  3. Choose a project type: Solution · Web Resource · Plugin · Portal.
  4. Provide your connection details (next step).

Initialisation scaffolds the chosen template, restores dependencies (npm / NuGet / pac), and writes a dataverse-powertools.json settings file to the workspace root.

Verify: the folder now contains project files and dataverse-powertools.json, and the activity-bar view shows the actions for your project type.


Step 4 — Connect to Dataverse

During initialisation you choose how to authenticate — Interactive sign-in (a browser sign-in, no app registration needed) or Service principal (client secret).

Then you pick an environment and a solution (the publisher prefix is inferred from it). Secrets are stored in VS Code secret storage, never in the settings file.

Verify: the status bar shows a $(database) icon with your environment URL, and Show Log reads Connected to Dataverse.

➡ Full details — including switching environments and fixing a stale connection — are in Connecting & Authentication.


Next steps

Clone this wiki locally