VS 2017: PackageType=DotnetCliTool fails to install

[natemcmaster]

Details

VS 2017: 15.0.26014
NuGet GUI
Worked in NuGet: 3.5.0.1996 with VS 2015 u3

Repro

1. File -> New -> Project -> .NET Core -> Console App
2. Project -> Manage NuGet packages...
3. Attempt to install a "CLI tool" package, e.g. https://www.nuget.org/packages/Microsoft.DotNet.Watcher.Tools/1.1.0-preview4-final

Fails with error:

Package 'Microsoft.DotNet.Watcher.Tools 1.1.0-preview4-final' has a package type 'DotnetCliTool' that is not supported by project 'ConsoleApp1'.

More details

The package's NuSpec:

    <packageTypes>
      <packageType name="DotnetCliTool" />
    </packageTypes>

Output window:

Restoring packages for C:\Users\nmcmaster\documents\visual studio 2017\Projects\ConsoleApp1\ConsoleApp1\ConsoleApp1.csproj...
Detected package downgrade: Microsoft.NETCore.App from 1.1.0 to 1.0.1 
 ConsoleApp1 (>= 1.0.0) -> Microsoft.DotNet.Watcher.Tools (>= 1.1.0-preview4-final) -> Microsoft.NETCore.App (>= 1.1.0) 
 ConsoleApp1 (>= 1.0.0) -> Microsoft.NETCore.App (>= 1.0.1)
Package 'Microsoft.DotNet.Watcher.Tools 1.1.0-preview4-final' has a package type 'DotnetCliTool' that is not supported by project 'ConsoleApp1'.
========== Finished ==========
Time Elapsed: 00:00:01.9317626

The project:

<Project Sdk="Microsoft.NET.Sdk" ToolsVersion="15.0">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp1.0</TargetFramework>
  </PropertyGroup>
  <ItemGroup>
    <Compile Include="**\*.cs" />
    <EmbeddedResource Include="**\*.resx" />
  </ItemGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.NETCore.App" Version="1.0.1" />
  </ItemGroup>
</Project>

cc @joelverhagen

[muratg]

@rrelyea, this used to work on VS2015 so looks like a regression that would impact all of the tool projects that use this flag.

@Eilon, could you add this bug to your tracking list?

[natemcmaster]

If this is helpful, here is the code that throws the exception: https://github.com/NuGet/NuGet.Client/blob/4cccb13833ad29d6a0bcff055460d964f1b49cfe/src/NuGet.Core/NuGet.PackageManagement/InstallationCompatibility.cs#L140-L157

[rrelyea]

@natemcmaster - We punted the work to support tools installs via the UI with the idea that tools will be installed by default with new projects ... and that people can edit the csproj if an addition is needed.
Make sense?

[natemcmaster]

Makes sense. Would still love to see this make it in to RTM.

But if this gets bumped, can we at least change the error? It currently says that the project doesn't support CLI tools, which may mislead some to believe .NET Core CLI tools don't work anymore.

[natemcmaster]

cc @DamianEdwards

[balachir]

+1 on a better error message when doing this from the Manage NuGet packages UI

Rob suggested it might be possible to get this working from the Install-Package power shell command for RC3 / RTM. @rrelyea ?

[bricelam]

dotnet add package doesn't support it correctly either.

[isaacrlevin]

This issue still exists with Dot Net Standard 2.0. Is there any update on this issue? I want to be able to use EF Core in a CL targeting standard 2.0 and this stops this from being possible

[geirsagberg]

As a workaround, you can edit the .csproj file and add the tool manually, e.g.:

  <ItemGroup>
    <DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Tools.Dotnet" Version="2.0.0-preview2-final" />
  </ItemGroup>

[j4zzlee]

@geirsagberg,
Still does not work. When use "dotnet restore", it still says: "... has a package type 'DotnetCliTool' that is not supported ..."

[AdrienTorris]

Same error than @st2forget . I tried to add the package manually in the csproj but the error is still the same.

[AdrienTorris]

It works now. I did nothing, just wait ...

[dtwilliams10]

Still not working for me, same error as @st2forget

[Eilon]

You still install them in the project (into the same CSPROJ file), but as tools references, not package references. They are represented as different XML elements inside the CSPROJ.

[Bunabun]

Any news on this? Are we doomed to forever manually edit the .csproj file?

[Eilon]

I think with the upcoming Global Tools feature the priority of this might be a bit lower.

I think @KathleenDollard and @richlander can share more thoughts on this.

[KathleenDollard]

Tools aren't really packages, they have a different purpose, so add package seems the wrong gesture.

We're working on a better tooling story overall, and EF is definitely in that mix. More to come soon.

[raffaeler]

@KathleenDollard are you saying that there is no solution for the current release of the product?

[cgountanis]

Still having this issue with the latest SDK.

Error when adding the tools via NUGET as well. Right now we have to add that line manually to do migrations etc...

<DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Tools.DotNet" Version="2.0.1" />

How are people using EF in CORE without this working?

[MisinformedDNA]

Because we are doing it manually as well. It's annoying, but it shouldn't block you.

[bricelam]

Here are the docs on how to install the EF Core tools. (manually)

[vmukunda]

As specified by @geirsagberg adding the following dependancy directly to the .csproj file worked for me.

<ItemGroup>
    <DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Tools.Dotnet" Version="2.0.0-preview2-final" />
 </ItemGroup>

[rkmr039]

start Developer Command Prompt for VS 2017 and change directory to current project
then run this command
dotnet add package Microsoft.EntityFrameworkCore.Tools.DotNet

and then rebuild the project

[SuperJMN]

I'm experiencing the same issue. Someone please fix it.

[rrelyea]

We're not planning on adding CLI support for dotnetclitoolreferences anymore.
dotnet global tools, etc... are the direction.

[MisinformedDNA]

@rrelyea What does that mean? Are you going to stop using DotNetCliToolReferences altogether? Or that they won't work when installed via the CLI. Cause this bug was occurring when installed via VS.

[CuneytBozyel]

I made it by running command in cmd:

dotnet add package Microsoft.EntityFrameworkCore.Tools.DotNet

Best regards!

it works for me

[cgountanis]

Little help for those trying Core 3 Preview

https://wildermuth.com/2019/08/19/My-First-Look-at-ASP-NET-Core-3-0