Add `dotnet tool exec` command for one-shot tool execution #49329

dsplaisted · 2025-06-10T21:41:12Z

This is a continuation of this PR: #48443

Design doc: dotnet/designs#334
Original issue: #31103

Updates from previous PR include:

First check if the tool package specified is installed as a local tool. If so, download it if necessary (without needing a confirmation prompt), and run it.
Only show confirmation prompt if the required packages aren't already in the global packages folder.

src/Cli/dotnet/CommonArguments.cs

src/Cli/dotnet/Commands/Tool/Execute/ToolExecuteCommand.cs

src/Cli/dotnet/ToolManifest/ToolManifestFinder.cs

src/Cli/dotnet/Commands/Tool/Install/ParseResultExtension.cs

src/Cli/dotnet/Commands/Tool/Execute/ToolExecuteCommand.cs

joeloff · 2025-06-10T22:33:35Z

src/Cli/dotnet/Commands/CliCommandStrings.resx

+  </data>
+  <data name="ToolDownloadConfirmationPrompt" xml:space="preserve">
+    <value>Tool package {0}@{1} will be downloaded from source {2}.
+Proceed? [y/n]</value>


Perhaps we could reword this to be more localization friendly. Something like Press 'y' to proceed or 'n' to decline. This way, we can translate proceed and decline, and lock the y/n keys from being localized. I imagine for non-Latin keyboards, we may need to translate the Y/N as well to display.

I think this is a good suggestion, but I personally prefer to be less verbose here.

MiYanni · 2025-06-10T22:58:12Z

src/Cli/dotnet/CliStrings.resx

@@ -812,4 +812,7 @@ For a list of locations searched, specify the "-d" option before the tool name.<
    <value>Cannot specify --version when the package argument already contains a version.</value>
    <comment>{Locked="--version"}</comment>
  </data>
+  <data name="YesOptionDescription" xml:space="preserve">
+    <value>Overrides confirmation prompt with "yes" value. </value>


Should "yes" not be translated? It sounds like a specific, non-localized value.

I've updated how the confirmation prompt works and is localiized. I think the yes string here can be localized.

src/Cli/dotnet/Commands/CliCommandStrings.resx

src/Cli/dotnet/Commands/Tool/Execute/ToolExecuteCommand.cs

src/Cli/dotnet/Commands/Tool/Execute/ToolExecuteCommandParser.cs

src/Cli/dotnet/Commands/Tool/Restore/ToolPackageRestorer.cs

src/Cli/dotnet/Commands/Tool/ToolCommandSpecCreator.cs

MiYanni · 2025-06-11T00:07:12Z

src/Cli/dotnet/Commands/Tool/ToolCommandSpecCreator.cs

+                    toolExecutable,
+                    commandArguments);
+            }
+            else if (toolRunner == "executable")


nit: Redundant else usage (both this else-if and the plain else).

It's redundant but seems a bit clearer to me like this. If you get rid of the elses you have to pay attention to the return statements inside the blocks to understand the overall flow.

src/Cli/dotnet/CommonArguments.cs

dsplaisted · 2025-06-11T15:25:16Z

@Forgind @joeloff @MiYanni Thanks for the reviews, I've applied some of the feedback so far and pushed those changes.

nagilson · 2025-06-11T20:37:48Z

src/Cli/dotnet/CliStrings.resx

@@ -812,4 +812,7 @@ For a list of locations searched, specify the "-d" option before the tool name.<
    <value>Cannot specify --version when the package argument already contains a version.</value>
    <comment>{Locked="--version"}</comment>
  </data>
+  <data name="YesOptionDescription" xml:space="preserve">
+    <value>Overrides confirmation prompt with "yes" value. </value>
+  </data>


Suggested change

</data>

<comment>{Locked="yes"}</comment>

</data>

I don't actually think this needs to be locked, I've updated the confirmation prompt to support localization better.

Doesn't accept imply yes (whereas decline implies no)?

src/Cli/dotnet/CliStrings.resx

nagilson · 2025-06-11T20:48:31Z

src/Cli/dotnet/Commands/Tool/Execute/ToolExecuteCommand.cs

+
+        if (!_interactive)
+        {
+            return false;


Good call to default to 'no' in this instance!

Per @baronfel, npx does it the other way 😀. So we still might change it.

Ah, that actually makes sense. No is better than no default, but I think we should change it too. It would make scripts more verbose. I don't see a scenario in CI where I'd write this but want to say no.

Co-authored-by: Michael Yanni <MiYanni@microsoft.com>

nagilson

Thanks for sprucing up the code in some places. I read through everything and couldn't find any issues in the logic with the time we have before preview 6 snaps. All of the remaining feedback seems like nits to me - good feedback yet not blocking. Very excited to see this feature rollout :)

edvilme and others added 30 commits June 9, 2025 14:15

Add command

6ec461c

Add logic for acquisition and running

a36b14b

Execute tool

2f27844

Load package if installed

9cc3c78

tool-run: --from-source

1322829

Save tool to temp directory

2b2e18c

Update translations

7706c72

Update cli snapshots

b9a03d2

Address pr comments

da3e28e

Fix typo

3349a73

Fix typo

dd13c53

Move logic to ToolRunFromSourceCommand.cs

0ea6696

Add options

f689647

Fix typo

69cf295

Run tool

623d36a

Simplify code and translations

1f6fc19

Update completions

aebf421

Add --interactive option

dda7732

Update Completion snapshots

fdc0161

tool-exec

1beb4bb

Update Completions

37f00f9

Update cli snapshots

5ccd294

Add version option

e07a46b

Pretty divider line

eae9ad8

Address pr feedback

9fd3045

Remove prompt for normal and quiter verbosities

fd1cc46

Store in nuget cache?

d15b933

Update based on PR feedback.

48c5699

Update strings

729fe49

Make package identity argument work better with nullability

4c9b747

dsplaisted requested a review from a team June 10, 2025 21:44

Forgind reviewed Jun 10, 2025

View reviewed changes

joeloff reviewed Jun 10, 2025

View reviewed changes

src/Cli/dotnet/Commands/Tool/Execute/ToolExecuteCommand.cs Outdated Show resolved Hide resolved

joeloff reviewed Jun 10, 2025

View reviewed changes

MiYanni approved these changes Jun 11, 2025

View reviewed changes

Apply code review feedback

68f0638

Fix exception handling in mock package downloader

cde3627

nagilson reviewed Jun 11, 2025

View reviewed changes

src/Cli/dotnet/CliStrings.resx Outdated Show resolved Hide resolved

dsplaisted added 3 commits June 11, 2025 16:44

Improve confirmation prompt and other text updates

2e33374

Address TODOs

cb66e95

Update CLI snapshots

4bbafef

dsplaisted force-pushed the dotnet-tool-exec branch from 05ef93b to 4bbafef Compare June 11, 2025 20:44

nagilson reviewed Jun 11, 2025

View reviewed changes

dsplaisted and others added 2 commits June 11, 2025 16:53

Update --yes option description

1d61173

Apply code review feedback

ccde6b0

Co-authored-by: Michael Yanni <MiYanni@microsoft.com>

dsplaisted force-pushed the dotnet-tool-exec branch from a46949c to ccde6b0 Compare June 11, 2025 20:55

nagilson approved these changes Jun 11, 2025

View reviewed changes

Update CLI snapshots

b080028

dsplaisted merged commit 4eeab32 into dotnet:main Jun 12, 2025
27 of 30 checks passed

build-analysis bot mentioned this pull request Jun 12, 2025

Microsoft.DotNet.Watch.UnitTests.FileWatcherTests.DeleteSubfolder has flaky test assertion #49233

Open

baronfel added the Document for new feature label Jun 12, 2025

baronfel mentioned this pull request Jun 12, 2025

[New article]: one-shot dotnet tool execution with dotnet tool exec dotnet/docs#46799

Open

joelverhagen mentioned this pull request Jun 12, 2025

[Feature]: Add support for an MCP server package type NuGet/NuGetGallery#10461

Open

12 tasks

Add dotnet tool exec command for one-shot tool execution #49329

Add dotnet tool exec command for one-shot tool execution #49329

Uh oh!

Conversation

dsplaisted commented Jun 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dsplaisted commented Jun 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nagilson Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nagilson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Add `dotnet tool exec` command for one-shot tool execution #49329

Add `dotnet tool exec` command for one-shot tool execution #49329

nagilson Jun 11, 2025 •

edited

Loading