Sdk: Add help support for new CLI commands

Created on 9 Apr 2018  路  16Comments  路  Source: dotnet/sdk

Steps to reproduce

dotnet help tool

Expected behavior

Would open an article for the command (which doesn't exist right now 馃槃)

Probably the following files should be updated:
https://github.com/dotnet/cli/blob/master/src/dotnet/README.md
https://github.com/dotnet/cli/blob/master/src/dotnet/BuiltInCommandsCatalog.cs

Actual behavior

You get an error message saying:
Specified command 'tool' is not a valid CLI command. Please specify a valid CLI commands. For more information, run dotnet help.

Environment data

dotnet --info output:

.NET Core SDK (reflecting any global.json):
Version: 2.1.300-preview3-008443
Commit: 1e2e8138b9

Runtime Environment:
OS Name: Windows
OS Version: 10.0.16299
OS Platform: Windows
RID: win10-x64
Base Path: C:Program Filesdotnetsdk2.1.300-preview3-008443

Host (useful for support):
Version: 2.1.0-preview3-26404-01
Commit: 1b1a652c15

.NET Core SDKs installed:
1.0.0 [C:Program Filesdotnetsdk]
1.0.4 [C:Program Filesdotnetsdk]
1.1.0 [C:Program Filesdotnetsdk]
2.0.0 [C:Program Filesdotnetsdk]
2.0.2 [C:Program Filesdotnetsdk]
2.0.3 [C:Program Filesdotnetsdk]
2.1.2 [C:Program Filesdotnetsdk]
2.1.100 [C:Program Filesdotnetsdk]
2.1.102 [C:Program Filesdotnetsdk]
2.1.103 [C:Program Filesdotnetsdk]
2.1.300-preview1-008174 [C:Program Filesdotnetsdk]
2.1.300-preview3-008443 [C:Program Filesdotnetsdk]

.NET Core runtimes installed:
Microsoft.AspNetCore.All 2.1.0-preview1-final [C:Program FilesdotnetsharedMicrosoft.AspNetCore.All]
Microsoft.AspNetCore.All 2.1.0-preview2-30431 [C:Program FilesdotnetsharedMicrosoft.AspNetCore.All]
Microsoft.AspNetCore.App 2.1.0-preview1-final [C:Program FilesdotnetsharedMicrosoft.AspNetCore.App]
Microsoft.AspNetCore.App 2.1.0-preview2-30431 [C:Program FilesdotnetsharedMicrosoft.AspNetCore.App]
Microsoft.NETCore.App 1.0.4 [C:Program FilesdotnetsharedMicrosoft.NETCore.App]
Microsoft.NETCore.App 1.0.5 [C:Program FilesdotnetsharedMicrosoft.NETCore.App]
Microsoft.NETCore.App 1.1.1 [C:Program FilesdotnetsharedMicrosoft.NETCore.App]
Microsoft.NETCore.App 1.1.2 [C:Program FilesdotnetsharedMicrosoft.NETCore.App]
Microsoft.NETCore.App 2.0.0 [C:Program FilesdotnetsharedMicrosoft.NETCore.App]
Microsoft.NETCore.App 2.0.3 [C:Program FilesdotnetsharedMicrosoft.NETCore.App]
Microsoft.NETCore.App 2.0.5 [C:Program FilesdotnetsharedMicrosoft.NETCore.App]
Microsoft.NETCore.App 2.0.6 [C:Program FilesdotnetsharedMicrosoft.NETCore.App]
Microsoft.NETCore.App 2.1.0-preview1-26216-03 [C:Program FilesdotnetsharedMicrosoft.NETCore.App]
Microsoft.NETCore.App 2.1.0-preview3-26404-01 [C:Program FilesdotnetsharedMicrosoft.NETCore.App]

To install additional .NET Core runtimes or SDKs:
https://aka.ms/dotnet-download

Most helpful comment

Ok, links created.

All 16 comments

There is no dotnet install command. The command is now dotnet tool, under which you can have install, update, list, remove.

@livarcocc fair enough. Updated the issue with the new name of the command.

We should add this for dotnet builserver as well. cc @peterhuene

I can help create the aka.ms links. Just let me know which ones you need.

@wli3 When we fix this for tool, mind just putting in a corresponding link for buildserver?

@mairaw I think we'll just follow the existing convention: https://aka.ms/dotnet-tool and https://aka.ms/dotnet-buildserver.

Sounds good. I'll create them now and point them to a temp location while docs are not created yet.

Ok, links created.

Thanks, @mairaw!

@peterhuene or @wli3 can we quickly take care of this issue, given that the links have been created?

@mairaw did you hear that we changed buildserver to build-server?

Nope @KathleenDollard. Do you want me to create the aka link as aka.ms/dotnet-build-server instead?

I had one already

@KathleenDollard you should have the control of aka.ms/dotnet-build-server. I created yesterday when i was working on adding it

https://github.com/dotnet/cli/pull/9079/files#diff-a48aa2c4aa9b112b14f4fade2d42efecR157

@livarcocc the PR is out. I am writing the email to shiproom
https://github.com/dotnet/cli/pull/9079

Ok, deleted the old dotnet-buildserver then. @wli3 please add me as an additional owner so I can update the link once the docs are out. Thanks!

Was this page helpful?
0 / 5 - 0 ratings