How to ‐ Make your tool available to the community - neronotte/Greg.Xrm.Command GitHub Wiki

You created, tested and deployed locally your tool, now it's time to make it available to the community!

Tools can be deployed as NuGet Packages.

!!! WARNING !!!

Third party tools can be harmful. PACX authors don't manage or have any responsibility on PACX tools codebases that are not explicitly listed in this documentation. Be sure to download and install only tools whose source/author is trusted. PACX creators deny any liability that my be associated with an improper use of PACX tools.

Now let's start creating our tool package!

Configure your project to output a NuGet package

If you created your project following the steps described in the previous articles of this series, your tool project is already ready to generate a NuGet project.

  1. In Visual Studio, Solution Explorer, right click on your project, then Properties.

image

  1. In the panel that will show up, flag "Produce a package file during build operations"

image

  1. Now it's time to fill in the info of your Tool Package. We list below the main ones (the required ones), you can find info for the other package properties in the official NuGet documentation

    • Package ID: leave it as it is, it must match your tool assembly name
    • Title: add a meaningful title for your package
    • Version: this is the version that will be listed in NuGet and used during the installation
    • README: this should point to a README.md file we suggest to put in the root folder of your tool assembly. The readme should contain information about the commands provided by your tool
    • Pack as .NET tool: DO NOT FLAG this.

  2. Rebuild your tool assembly. You will find a .nupkg file in the \bin\Debug folder.

image

Upload your package on NuGet

Once you have your NuGet package ready, you can follow official MS walkthrough to upload the package on NuGet. Once the package is listed, NuGet will show a page like this:

image

And the package is ready to be installed via


pacx tool install --name MyFirstPacxTool

No more excuses... start creating tools! 🚀

Index

Back to the index