Blueprints

A collection of dotnet new templates for common project types and workflows.

📖 Documentation

Installing, Updating, and Uninstalling

Installation

Blueprints is published to GitHub Packages. To install it, you'll need a GitHub personal access token (PAT) with at least read:packages scope.

1. Create a PAT

Go to GitHub Settings → Developer Settings → Personal Access Tokens and create a token with the read:packages scope.

2. Store the PAT as an Environment Variable

Store your PAT as an environment variable rather than entering it in plain text on the command line.

macOS/Linux

export GITHUB_PAT=your_pat_here

PowerShell

$env:GITHUB_PAT = "your_pat_here"

Windows (Command Prompt)

setx GITHUB_PAT "your_pat_here"

3. Add the NuGet Source

The --name flag sets the key used to identify this source in your local NuGet configuration. It can be anything you like -- the value below is just a suggestion.

macOS/Linux

dotnet nuget add source "https://nuget.pkg.github.com/scottoffen/index.json" \
  --name "scottoffen" \
  --username YOUR_GITHUB_USERNAME \
  --password $GITHUB_PAT

PowerShell

dotnet nuget add source "https://nuget.pkg.github.com/scottoffen/index.json" `
  --name "scottoffen" `
  --username YOUR_GITHUB_USERNAME `
  --password $env:GITHUB_PAT

Windows (Command Prompt)

dotnet nuget add source "https://nuget.pkg.github.com/scottoffen/index.json" ^
  --name "scottoffen" ^
  --username YOUR_GITHUB_USERNAME ^
  --password %GITHUB_PAT%

4. Install the Package

dotnet new install ScottOffen.Blueprints

Updating

To update to the latest version:

dotnet new update ScottOffen.Blueprints

Uninstalling

To remove the templates:

dotnet new uninstall ScottOffen.Blueprints

Local Development

To install the templates locally from source for testing:

dotnet new install src/Blueprints

To uninstall:

dotnet new uninstall src/Blueprints

After making changes to the templates, uninstall and reinstall to pick up the changes:

dotnet new uninstall src/Blueprints && dotnet new install src/Blueprints

To verify the templates are installed:

dotnet new list --author "Scott Offen"

Template Naming Convention

Template folder names follow the convention template-[scope]-[ecosystem]-[descriptor].

Scope describes what the template creates:

Value	Description
repo	An entire repository structure
sln	A solution structure (multiple projects)
project	A single project
partial	A partial project addition (e.g., a Docker container, a GitHub Actions workflow)

Ecosystem identifies the technology:

Value	Description
dotnet	C# / .NET
php	PHP
js	JavaScript
ts	TypeScript
docker	Docker
gh	GitHub (Actions, workflows, etc.)

Descriptor is a short name for what the template specifically creates, such as osspkg, webapi, console, mysql, or postgres.

Templates

Short Name	Description
coming soon	coming soon

License

This project is dual licensed under the MIT License and the Apache License 2.0. You may choose either license at your option.