Skip to content

Document NuGet tool installation #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Benziza merged 1 commit into from
Sep 17, 2026
Merged

Document NuGet tool installation #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,21 @@ See which .NET configuration source set a value, and which values it replaced.

![Animated demo of whyconfig explaining Database:Host](assets/whyconfig-demo.gif)

## Try it
## Install

Requires the .NET 10 SDK. From this repository, run:
Requires the .NET 10 SDK.

```bash
dotnet run --project src/WhyConfig.Cli -- explain Database:Host --project path/to/YourApp --environment Development
dotnet tool install -g WhyConfig.NET
```

The CLI checks the project's `appsettings` files, Development User Secrets, and current environment variables. Run `dotnet run --project src/WhyConfig.Cli -- --help` for options.
## Use

```bash
whyconfig explain Database:Host --project path/to/YourApp --environment Development
```

The CLI checks the project's `appsettings` files, Development User Secrets, and current environment variables. Run `whyconfig --help` for options.

For the exact configuration of a running app, use `WhyConfig.Core` with its `IConfigurationRoot`:

Expand Down