--local option is not documented

[alexandair]

--local option is not documented.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 3ceadded-82f0-9b11-36b3-a5582a4a57d7
• Version Independent ID: 27f38a93-1b87-d5e2-c7d4-29faf36ea521
• Content: dotnet tool list command - .NET Core CLI
• Content Source: docs/core/tools/dotnet-tool-list.md
• Product: dotnet-core
• Technology: dotnet-cli
• GitHub Login: @tdykstra
• Microsoft Alias: tdykstra

[Youssef1313]

The current docs says:

• A local tool. Omit the --global and --tool-path options.

So, it seems that dotnet tool list --local is equivalent to just dotnet tool list. However, I surely agree that it needs to be documented.

I'll wait until @tdykstra review this, and confirm that dotnet tool list --local is the same as dotnet tool list, then I can submit a PR.

[tdykstra]

@wli3 -- Is dotnet tool list the same as dotnet tool list --local?

And why does the command's --help output show PATH in the description -- when I try to specify a path with --local it responds unrecognized command or argument

dotnet tool list -h
Usage: dotnet tool list [options]

Options:
  -g, --global         List tools installed for the current user.
  --local              PATH
  --tool-path <PATH>   The directory containing the tools to list.
  -h, --help           Show command line help.

[wli3]

dotnet tool list should be the same as dotnet tool list --local. Looks like "unrecognized command or argument" is a bug

[alexandair]

"unrecognized command or argument" is not a bug. --local option doesn't accept any value.

--help output show PATH in the description -- and, that's a bug

Description for both dotnet tool list and dotnet tool list --local should be something like:

Lists all local tools available in the current directory.

[danmoseley]

Incidentally, I found it confusing that dotnet tool list is implicitly local. ie, I had a tool installed globally already, and forgot about it. Then I did

C:\Users\danmose>dotnet tool install -g dotnet-sos
Tool 'dotnet-sos' is already installed.

So naturally I did

C:\Users\danmose>dotnet tool list
Package Id      Version      Commands      Manifest
---------------------------------------------------

C:\Users\danmose>

Is it too late to make dotnet tool list list both local and global? dotnet tool --local --global is also rejected.

[augustoproiete]

@danmosemsft +1. It would be great if that was done together with #14626 so that when you see a tool in the list, you know you can run it with the same command without having to worry about it being a local tool vs a global tool.

The executable shim should be generated for local tools as well (it isn't today), and dotnet <toolCommandName> should work regardless if the tool was installed as local or global (it doesn't work for global tools).