[.NET Core] Command-Line Tool 介紹

習慣在 Windows ＋ Visual Studio 進行開發工作的 .NET programmer 在一開始轉入 .NET Core 時最大的不解應該是，何謂 Command-Line Interface (CLI) 了？

Photo by hannah joshua on Unsplash

.NET Command-Line Interface (CLI)

.NET Command-Line interface (CLI) 基本上就是一個下指令的介面，這些指令可以執行 .NET Core 上的相關操作，例如 dotnet new mvc 可以建立一個 .NET Core MVC 的專案；另外 dotnet --info 則是列出目前環境的資訊，包含安裝的 .NET Core Runtime 列表等。

為什麼還要有 CLI 呢？基於 .NET Core 是一個跨平台的框架，所以 .NET CLI 也是跨平台的，表示同一個指令在不同平台上的結果是一樣的。.NET CLI 包含在 .NET Core SDK 裡面中，只要安裝好 .NET Core SDK 就可以使用 CLI 中的指令了。以下是 CLI 的一些相關資訊：

• .NET Core SDK 原始碼

沒錯，.NET Core SDK 也是開源的。基本上，dotnet 這個指令就是一個 console 專案開發的。

• .NET CLI overview

Microsoft Docs 網站上針對 CLI 指令的詳細說明。

.NET Tools 

.NET Core 是允許我們開發自已的 Command-Line 指令，而這些在 Command-Line Interface 上使用的指令 (或工具)，一般稱為 .NET Tools。 其實 .NET Tool 是一特殊的 NuGet package 裡面包含 Console Application，安裝後可透過 CLI 執行。

如果有興趣知道 .NET Tool 是如何開發的，建議可以在 Google 搜尋 custom dotnet tool 就會不少的參考資料。Microsoft Docs 網站上也有一篇 Tutorial: Create a .NET tool using the .NET CLI 範例說明如何建立一個 .NET tool。

.NET Tools 的安裝有兩種，一是安裝成 Global Tool；另一是 Local Tool。在說明安裝前先介紹一個 Microsoft 提供的 .NET Tool，叫 dotnetsay 。這個 .NET Tool 純粹是示範用途而己，不會執行什麼操作，就是在 Command 視窗上顯示一個圖。你可以在 nuget 網站上輸入 dotnetsay 就可以找到該 .NET Tool，也可以去 GitHub 上看看他的原始碼。

As a local tool

Local tool 是將指令安裝專案下的路徑，因此該指令只有在專案下是有效的。安裝指令如下：

dotnet tool install dotnetsay

As a global tool

Global tool 是將指令安裝系統指定的路徑，因該路徑已在環境中設好 PATH，因此安裝好的 global tool 就是一個全域工具。

dotnet tool install -g dotnetsay

全域的安裝就是加上 -g 這個參數即可，如果是在 Windows 的環境，預設的安裝路徑是 %USERPROFILE%\.dotnet\tools；如果是 Linux/MacOS 安裝路徑則是 $HOME/.dotnet/tools 。

～Keeping Coding; Keep Writing