Skip to content

Document NuGet HTTPS client certificate CLI commands - #56533

Open
zivkan wants to merge 2 commits into
dotnet:mainfrom
zivkan:nuget-client-certificates
Open

zivkan wants to merge 2 commits into
dotnet:mainfrom
zivkan:nuget-client-certificates

Conversation

@zivkan

@zivkan zivkan commented Oct 23, 2026 •

Copy link
Copy Markdown
Member

Summary

Add reference pages for dotnet nuget add, update, list, and remove client-cert. Document file and certificate-store options, password handling, command limitations, and examples. Add navigation links and alphabetize the NuGet command lists.

Related to NuGet/Home#13485. This PR covers the .NET CLI documentation, not the NuGet CLI or standalone conceptual documentation.

Sources and AI usage: Adapt the four command sections from the accepted specification, checked against NuGet/NuGet.Client#3273 and the current implementation. No content is copied verbatim. AI-generated explanations and examples are marked with ai-usage: ai-generated. The file-certificate --configfile requirement warrants maintainer review because it reflects an implementation limitation.

Validation: Executed all command examples on Windows with .NET SDKs 8.0.426, 9.0.319, and 10.0.402:

  • File and store additions reported success; protected-file passwords were encrypted.
  • File and store updates reported success.
  • Both list examples displayed the configured certificate thumbprint.
  • Removal reported success and preserved the certificate file and package source.

Also verified duplicate and mixed-option errors, certificate-type restrictions, FindBy prefix rejection, --force behavior, and local links and navigation. Historical SDKs, Linux, macOS, and live HTTPS authentication were not tested.


Internal previews

File Preview link
docs/core/tools/dotnet-nuget-add-client-cert.md Learn preview
docs/core/tools/dotnet-nuget-add-source.md Learn preview
docs/core/tools/dotnet-nuget-list-client-cert.md Learn preview
docs/core/tools/dotnet-nuget-remove-client-cert.md Learn preview
docs/core/tools/dotnet-nuget-update-client-cert.md Learn preview
docs/core/tools/dotnet.md Learn preview
docs/navigate/tools-diagnostics/toc.yml Learn preview

Build report

Copilot AI balanced review requested due to automatic review settings October 23, 2026 04:06
@zivkan
zivkan requested a review from BillWagner as a code owner October 23, 2026 04:06
@dotnetrepoman dotnetrepoman Bot added this to the October 2026 milestone Oct 23, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Certificate search limitations and relative-path lookup precedence need clarification to prevent failed lookups or unintended certificate selection.

2 open issues
What changed in this PR

Add .NET CLI reference documentation for NuGet HTTPS client certificate management, with links from existing command navigation.

Changes:

  • Document the add, update, list, and remove commands with options, limitations, password guidance, and examples.
  • Add navigation links and alphabetize the NuGet command lists.
  • Link package-source setup to client certificate configuration.
File Description
docs/​navigate/​tools-diagnostics/​toc.yml Add certificate commands and alphabetize navigation.
docs/​core/​tools/​dotnet.md Add certificate commands to the CLI command table.
docs/​core/​tools/​dotnet-nuget-update-client-cert.md Document certificate configuration updates.
docs/​core/​tools/​dotnet-nuget-remove-client-cert.md Document configuration removal and what remains unchanged.
docs/​core/​tools/​dotnet-nuget-list-client-cert.md Document certificate listing and output.
docs/​core/​tools/​dotnet-nuget-add-source.md Link to client certificate setup.
docs/​core/​tools/​dotnet-nuget-add-client-cert.md Document file-based and store-based certificate setup.

Review effort: Balanced

Comment thread docs/core/tools/dotnet-nuget-add-client-cert.md Outdated
Comment thread docs/core/tools/dotnet-nuget-add-client-cert.md Outdated
@zivkan
zivkan requested a review from a team October 23, 2026 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants