Skip to content

Requirements

Peter McDonald edited this page Aug 12, 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

That's the whole list. Web-resource tooling (webpack, jest, TypeScript) is installed per project as local dev dependencies during project creation — no global npm installs.

Cross-platform: the extension runs on Windows, macOS, and Linux — including web resource typings, which use a bundled cross-platform XrmDefinitelyTyped run via dotnet. The one Windows-only feature left is capturing a plug-in profile (Profile next run) — the capture tool is .NET Framework. Downloading a captured run and replaying it under the debugger work everywhere.

Recommended VS Code extensions

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

Step 2 — Check the requirements in the Actions panel

Open the Dataverse PowerTools activity-bar panel. The System Requirements card scans for the .NET SDK, Node.js and pac, showing ✓/✗ per tool with a download link for anything missing (Recheck Requirements re-runs the scan). Once everything is green the card collapses to a single ✓ requirements line in the panel footer.

Verify: the panel shows ✓ requirements (or three green rows) before you build or deploy.

Prefer a guided setup? The Getting Started walkthrough (Help → Get Started, or Open Walkthrough in the panel) walks these steps with self-completing checkmarks:

Walkthrough


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