Skip to main content

Getting Started

Follow these steps to get up and running with the CLI.

What you'll need​

  • Node.js (for installing Docusaurus if hosting docs yourself)
  • .NET 6 SDK
  • A Power Platform environment and appropriate user credentials

Install the CLI Tool​

Install via NuGet with the following command:

dotnet tool install --global XrmDocumentationGeneratorCoreCLI

If you already have it installed and want to update:

dotnet tool update --global XrmDocumentationGeneratorCoreCLI

Run Your First Command​

Generate your documentation output with:

xrm-docgen --url [https://org.crm.dynamics.com](https://org.crm.dynamics.com) --client-id YOUR\_APP\_ID --client-secret YOUR\_SECRET --output docs/

This will connect to your Dataverse environment and generate markdown files in the specified output folder.

Open those files with Docusaurus, or any markdown-friendly viewer.

Start Docusaurus (Optional)​

To preview documentation locally:

npx create-docusaurus\@latest my-doc-site classic
cd my-doc-site
npm run start