To build a website with ScissorHands.NET, you should have the following prerequisites.

Development Environment

• .NET 10 SDK or later
• Visual Studio 2026 or VS Code with C# DevKit
• GitHub account (free)

Access to GitHub NuGet Package Registry

Currently ScissorHands.NET can be downloaded only from GitHub NuGet Package Registry, which requires authentication with PAT (Personal Access Token).

1. Create a PAT (classic) containing the read:packages scope.

2. Set environment variables for GitHub NuGet Package Registry.

   # zsh/bash
   source ./scripts/setup-gh-auth.sh \
       --username "<GITHUB_USERNAME>" --token "<GITHUB_TOKEN>"
   

   # PowerShell
   . ./scripts/setup-gh-auth.ps1 `
       -Username "<GITHUB_USERNAME>" -Token "<GITHUB_TOKEN>"
   

   NOTE: Make sure to sourcing the script instead of executing it.

3. Make sure that you've got a NuGet.config file that registers the GitHub NuGet Package Registry for ScissorHands.NET. Here's the example of NuGet.config.

   <?xml version="1.0" encoding="utf-8"?>
   <configuration>
     <packageSources>
       <add key="github"
            value="https://nuget.pkg.github.com/getscissorhands/index.json" />
     </packageSources>
     <packageSourceCredentials>
       <github>
           <add key="Username" value="%GH_PACKAGE_USERNAME%" />
           <add key="ClearTextPassword" value="%GH_PACKAGE_TOKEN%" />
         </github>
     </packageSourceCredentials>
   </configuration>
   

Congratulations! You're ready to use ScissorHands.NET!

👆 Documentation | Quickstart 👉