XrmDocumentationGeneratorCLI 1.0.0

dotnet add package XrmDocumentationGeneratorCLI --version 1.0.0
NuGet\Install-Package XrmDocumentationGeneratorCLI -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="XrmDocumentationGeneratorCLI" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add XrmDocumentationGeneratorCLI --version 1.0.0
#r "nuget: XrmDocumentationGeneratorCLI, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install XrmDocumentationGeneratorCLI as a Cake Addin
#addin nuget:?package=XrmDocumentationGeneratorCLI&version=1.0.0

// Install XrmDocumentationGeneratorCLI as a Cake Tool
#tool nuget:?package=XrmDocumentationGeneratorCLI&version=1.0.0

XrmDocumentationGenerator

XrmDocumentationGenerator is a 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 with .NET Framework 4.6.2.

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.

Install

dotnet tool install --global XrmDocumentationGeneratorCLI

Run command

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

DocumentType is only and by default "simplesyntax" in this version

Author

Ramy Victor

License

This project is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 117 3/17/2023