VATOKSGet contact

GuardTool / Getting started

GuardTool
Getting started.

.NET 8.0 or later. Start with the official release, then follow the steps below.

Open NuGet
  1. 01

    Install the .NET tool

    With a compatible .NET SDK available, install the published global tool from NuGet.

    dotnet tool install --global GuardTool.Tool
  2. 02

    Scan your project

    Run this command from your ASP.NET Core project directory. The dot refers to the current directory.

    guardtool scan --root .
  3. 03

    Export useful reports

    Generate HTML and SARIF alongside the JSON report. Reports are stored in .guardtool/reports by default.

    guardtool scan --root . --html --sarif
  4. 04

    Review in the dashboard

    Open the local dashboard to browse the generated reports.

    guardtool dashboard --root .
  5. 05

    Add a pipeline checkpoint

    Use a failure threshold to stop a build when critical findings are detected.

    guardtool scan --root . --fail-on=critical

If something doesn’t work

Check that a compatible .NET SDK is installed and the global tool is available in your terminal. Run the scan from the intended project directory. If the command is not found after installation, open a new terminal.

When contacting us, include your product version, operating system and the steps that led to the issue. Remove sensitive data before sharing screenshots or logs.

Ask a question

Published by Vatoks. Based on the official NuGet listing. Consult the listing for the latest release and requirements.