StrawhatsCompany.SHFramework.Templates 3.15.0

Strawhats Framework Templates

A dotnet new template (shf) that scaffolds a Clean Architecture .NET 10 service: CQRS, minimal API, vertical-slice features, provider pattern, OpenAPI metadata, health checks, exception handling, rate limiting, and a secrets convention built around user-secrets.

Install

dotnet new install StrawhatsCompany.SHFramework.Templates

Scaffold a service

dotnet new shf -n Strawhats.YourService -o ./your-service
cd ./your-service/src
dotnet build
dotnet run --project WebApi

The scaffolded service boots on https://localhost:7257. Hit https://localhost:7257/health/live to see it's alive. The Weather example endpoint is at /api/v1/weather/forecasts/{city} (alpha characters only).

Companion CLI

For day-to-day work, install shf-cli and use it to scaffold features, endpoints, entities, providers, persistence projects, and migrations:

dotnet tool install -g StrawhatsCompany.SHFramework.Cli

shf make:feature Weather/GetWeeklyForecast
shf make:endpoint Weather/GetWeeklyForecast
shf make:entity   Orders/Order --properties "CustomerName:string?,Amount:decimal"
shf make:provider Sms --first-driver Twilio
shf make:persistence postgres --connection-string "Host=localhost;Database=AppDb;Username=postgres;"
shf make:migration AddForecastTable

Configuration

Non-secret defaults live in appsettings.json. Secrets — provider credentials, API keys, encryption keys, connection-string passwords — live in user-secrets (dev) or environment variables / a secret store (prod). See docs/SECRETS.md.

cd src/WebApi
dotnet user-secrets set "Mail:Password" "your-smtp-password"

What's in the box

Target framework: net10.0. See CLAUDE.md for the full conventions.

Supported matrix

This template is a bill of materials for the SH Framework family — each release pins a vetted set of sibling library versions. Pin the template version in your service, and you get a tested combination. The actual versions live in src/Directory.Build.props (MSBuild properties), referenced from the consuming csprojs via Version="$(SHxxxVersion)". The table below is the human-readable changelog.

The first four columns are package references resolved at restore time. The CLI is a dotnet tool — install separately with dotnet tool install -g StrawhatsCompany.SHFramework.Cli. The matrix lists the CLI version this template release was tested against; newer minor/patch CLI versions are expected to remain compatible.

Rule of thumb: when a sibling library bumps and we want to adopt it, bump SHxxxVersion in src/Directory.Build.props AND bump this template's <PackageVersion> (patch for a lib fix, minor for a lib feature). Add a new row to this table.

Audit + skills

The repo ships two project-scoped Claude Code skills under .claude/skills/:

• feature-audit — bugs / security / performance lens.
• framework-compliance — CLAUDE.md rule compliance.

Both audit docs in docs/ record the findings that produced the current state.

Build from source

git clone git@github.com:StrawhatsCompany/sh-framework-template.git
cd sh-framework-template/src
dotnet build
dotnet test
dotnet pack StrawhatsCompany.SHFramework.Templates.csproj -c Release -o ../artifacts

License

MIT — see LICENSE.