Setup SQLDocs

Jump to bottom

Frank Stüber edited this page Mar 10, 2025 · 4 revisions

Setup for Windows

The following dependencies are necessary for the use of SQLDocs:

.NET 9 Runtime

Download and run the SQLDocs Windows Installer:

Open the GitHub Relases page of SQLDocs.
Download the newest sqldocs-x64.msi file to your local computer and run the MSI package.
Follow the on-screen instructions of the installation wizard. As a result, you can start SQLDocs via sqldocs from the command prompt (the installation folder is automatically added to the system environment variable PATH).

Setup for other platforms

The following dependencies are necessary for the use of SQLDocs:

.NET 9 Runtime

Download the SQLDocs binary archive:

Open the GitHub Relases page of SQLDocs.
Download the newest sqldocs-portable.zip file to your local computer.
Unzip the contents to the location of your choice and run dotnet SqlDocs.dll from there.