Cratis Templates

This repository contains all creation templates used by Cratis. It holds project and item templates you can use to scaffold new Cratis-based applications, components, and sample projects.

Builds

How to use

Quick steps to scaffold projects from these templates:

• Install the published templates from NuGet.org (one-time):

dotnet new install Cratis.Templates

• Optional: install a specific version:

dotnet new install Cratis.Templates::<version>

• Optional: install prerelease builds from GitHub Packages:

dotnet nuget add source --name cratis-github --username <github-username> --password <github-token> --store-password-in-clear-text https://nuget.pkg.github.com/cratis/index.json
dotnet new install Cratis.Templates::<version> --nuget-source https://nuget.pkg.github.com/cratis/index.json

• List available templates and note the Short Name you want:

dotnet new --list

• Create a new project from a template (replace <shortname>):

dotnet new <shortname> -n MyApp -o MyApp

• Many templates accept parameters; run dotnet new <shortname> --help to see available options.

• Uninstall when needed:

dotnet new uninstall Cratis.Templates

Updating installed templates

To update to the latest version:

dotnet new update

This updates all installed template packages to their latest versions.

To update only Cratis.Templates:

dotnet new uninstall Cratis.Templates
dotnet new install Cratis.Templates

To check which version you currently have installed:

dotnet new list

Look for Cratis.Templates in the output to see the installed version.

To update to a specific version:

dotnet new uninstall Cratis.Templates
dotnet new install Cratis.Templates::<version>

Build & Test Locally

Prerequisites:

• .NET SDK (recommended 8.0+)
• Node.js and npm (if testing frontend/Vite templates)

Pack and install the templates locally

dotnet pack Cratis.Templates.csproj -c Release -o ./nupkgs
dotnet new -i ./nupkgs

If you prefer to install directly from the template folder (unpacked):

dotnet new -i ./Cratis.Templates

List available templates and find the short name

dotnet new --list

Create a test project from a template (replace with the template short name)

dotnet new <shortname> -n MyTestApp
cd MyTestApp
dotnet restore
dotnet build
dotnet run

If the generated project includes a frontend (Vite/Node)

cd path/to/generated/frontend
npm install
npm run dev

Uninstall the local template when finished

dotnet new -u <package-id-or-folder>

Iterate on the template sources, repack, and reinstall to test changes quickly.