XrmDocumentationGeneratorCLI

XrmDocumentationGeneratorCLI is a dotnet tool that generates PowerApps documentation for your Microsoft Dataverse solutions. It simplifies the documentation process and helps you keep track of your solution's components.

Features

• Generates documentation in simple syntax markdown format.
• Supports connection string for Dataverse.
• Allows specifying the solution logical name to document.
• Customizable output path for the generated document.
• Built in .NET6.0

Usage

The XrmDocumentationGenerator can be used as a System.CommandLine tool to generate documentation for your PowerApps solutions. Please refer to the GitHub repository for detailed instructions on usage and installation. Generates a table for each form inside a solution with the metadata and related PowerAutomate flows and dependencies to give an overview

Install

dotnet tool install --g XrmDocumentationGeneratorCoreCLI

Run command

XrmDocumentationGeneratorCoreCLI generate -connection $connectionString -solution $solutionName -out $outputPath -documentType $documentType

The given command is using the XrmDocumentationGeneratorCoreCLI tool to generate documentation for a Dynamics 365 solution. The command includes several parameters that are passed to the tool:

• -connection specifies the connection string for connecting to the Dynamics 365 instance.
• -solution specifies the name of the solution for which the documentation is being generated.
• -out specifies the output path where the generated documentation will be saved.
• -documentType specifies the type of documentation that will be generated. In this case, it is set to "simplesyntax", which is the only supported document type in this version of the tool.

The output of the command will be in markdown format and will be saved to the specified output path. It is important to note that the result will be inside markdown code only, which means that it will be formatted as code within the markdown document and will not be displayed as plain text.

Supported connection string

Microsoft Documentation #(ClientId or Client Secret based authentication)

AuthType=ClientSecret;url=https://contosotest.crm.dynamics.com;ClientId={AppId};ClientSecret={ClientSecret}

Author

Ramy Victor

License

This project is licensed under the MIT License.