Cara mengelola alat .NET

  • Artikel

Artikel ini berlaku untuk: ✔️ .NET Core 2.1 SDK dan versi yang lebih baru.

Alat .NET adalah paket NuGet khusus yang berisi aplikasi konsol. Anda dapat menginstal alat di komputer Anda dengan cara berikut:

  • Sebagai alat global.

    Biner alat diinstal dalam direktori default yang ditambahkan ke variabel lingkungan PATH. Anda dapat memanggil alat dari direktori apa pun di komputer tanpa menentukan lokasinya. Satu versi alat digunakan untuk semua direktori pada komputer.

  • Sebagai alat global di lokasi kustom (juga dikenal sebagai alat jalur alat).

    Biner alat diinstal di lokasi yang Anda tentukan. Anda dapat memanggil alat dari direktori penginstalan, dengan menyediakan direktori dengan nama perintah, atau dengan menambahkan direktori ke variabel lingkungan PATH. Satu versi alat digunakan untuk semua direktori pada komputer.

  • Sebagai alat lokal (berlaku untuk .NET Core SDK 3.0 dan versi yang lebih baru).

    Biner alat dipasang di direktori default. Anda dapat memanggil alat dari direktori penginstalan atau subdirektorinya. Direktori yang berbeda dapat menggunakan berbagai versi alat yang sama.

    .NET CLI menggunakan file manifes untuk melacak alat yang diinstal sebagai lokal ke direktori. Ketika file manifes disimpan di direktori akar repositori kode sumber, kontributor dapat mengkloning repositori dan memanggil satu perintah .NET CLI untuk menginstal semua alat yang tercantum dalam file manifes.

Penting

Alat .NET berjalan dengan kepercayaan penuh. Jangan instal alat .NET kecuali Anda mempercayai penulis.

Alat .NET mungkin tidak berfungsi dengan benar jika .NET diinstal melalui Snap.

Menemukan alat

Berikut adalah beberapa cara untuk menemukan alat:

Periksa penulis dan statistik

Alat .NET dapat menjadi kuat karena berjalan dengan kepercayaan penuh, dan alat global ditambahkan ke variabel lingkungan PATH. Jangan unduh alat dari orang yang tidak Anda percayai.

Jika alat dihosting di NuGet, Anda dapat memeriksa penulis dan statistik dengan mencari alat tersebut.

Menginstal alat global

Untuk menginstal alat sebagai alat global, gunakan -g opsi atau --global penginstalan alat dotnet, seperti yang ditunjukkan dalam contoh berikut:

dotnet tool install -g dotnetsay

Output menunjukkan perintah yang digunakan untuk memanggil alat dan versi yang diinstal, mirip dengan contoh berikut:

You can invoke the tool using the following command: dotnetsay
Tool 'dotnetsay' (version '2.1.4') was successfully installed.

Catatan

Secara default arsitektur biner .NET yang akan diinstal mewakili arsitektur OS yang sedang berjalan. Untuk menentukan arsitektur OS yang berbeda, lihat penginstalan alat dotnet, opsi --arch.

Lokasi default untuk biner alat tergantung pada sistem operasi:

OS Jalur
Linux/macOS $HOME/.dotnet/tools
Windows %USERPROFILE%\.dotnet\tools

Lokasi ini ditambahkan ke jalur pengguna saat SDK pertama kali dijalankan. Jadi alat global dapat dipanggil dari direktori apa pun tanpa menentukan lokasi alat.

Akses alat khusus pengguna, bukan mesin global. Alat global hanya tersedia untuk pengguna yang menginstal alat.

Menginstal alat global di lokasi kustom

Untuk menginstal alat sebagai alat global di lokasi kustom, gunakan --tool-path opsi penginstalan alat dotnet, seperti yang ditunjukkan dalam contoh berikut:

Di Windows:

dotnet tool install dotnetsay --tool-path c:\dotnet-tools

Di Linux atau macOS:

dotnet tool install dotnetsay --tool-path ~/bin

.NET SDK tidak menambahkan lokasi ini secara otomatis ke variabel lingkungan PATH. Untuk memanggil alat jalur alat, Anda harus memastikan bahwa perintah tersedia dengan menggunakan salah satu metode berikut:

  • Tambahkan direktori penginstalan ke variabel lingkungan PATH.
  • Tentukan jalur lengkap ke alat saat Anda memanggilnya.
  • Panggil alat dari dalam direktori penginstalan.

Menginstal alat lokal

Berlaku untuk .NET Core 3.0 SDK dan yang lebih baru.

Jika Anda ingin menginstal alat untuk akses lokal saja (untuk direktori dan subdirektori saat ini), Anda harus menambahkan alat ke file manifes alat. Untuk membuat file manifes alat, jalankan dotnet new tool-manifest perintah :

dotnet new tool-manifest

Perintah ini membuat file manifes bernama dotnet-tools.json di bawah direktori .config . Untuk menambahkan alat lokal ke file manifes, gunakan perintah penginstalan alat dotnet dan hilangkan --global opsi dan --tool-path , seperti yang ditunjukkan dalam contoh berikut:

dotnet tool install dotnetsay

Output perintah menunjukkan di mana file manifes alat yang baru diinstal ada, mirip dengan contoh berikut:

You can invoke the tool from this directory using the following command:
dotnet tool run dotnetsay
Tool 'dotnetsay' (version '2.1.4') was successfully installed.
Entry is added to the manifest file /home/name/botsay/.config/dotnet-tools.json.

Contoh berikut menunjukkan file manifes dengan dua alat lokal terinstal:

{
  "version": 1,
  "isRoot": true,
  "tools": {
    "botsay": {
      "version": "1.0.0",
      "commands": [
        "botsay"
      ]
    },
    "dotnetsay": {
      "version": "2.1.3",
      "commands": [
        "dotnetsay"
      ]
    }
  }
}

Anda biasanya menambahkan alat lokal ke direktori akar repositori. Setelah Anda memeriksa file manifes ke repositori, pengembang yang memeriksa kode dari repositori mendapatkan file manifes terbaru. Untuk menginstal semua alat yang tercantum dalam file manifes, mereka menjalankan dotnet tool restore perintah:

dotnet tool restore

Output menunjukkan alat yang dipulihkan:

Tool 'botsay' (version '1.0.0') was restored. Available commands: botsay
Tool 'dotnetsay' (version '2.1.3') was restored. Available commands: dotnetsay
Restore was successful.

Menginstal versi alat tertentu

Untuk menginstal versi pra-rilis atau versi alat tertentu, tentukan nomor versi dengan menggunakan --version opsi , seperti yang ditunjukkan dalam contoh berikut:

dotnet tool install dotnetsay --version 2.1.3

Untuk menginstal versi pra-rilis alat tanpa menentukan nomor versi yang tepat, gunakan --version opsi dan berikan kartubebas, seperti yang ditunjukkan dalam contoh berikut:

dotnet tool install --global dotnetsay --version "*-rc*"

Menggunakan alat

Perintah yang Anda gunakan untuk memanggil alat mungkin berbeda dari nama paket yang Anda instal. Untuk menampilkan semua alat yang saat ini diinstal pada komputer untuk pengguna saat ini, gunakan perintah daftar alat dotnet:

dotnet tool list

Output menunjukkan versi dan perintah setiap alat, mirip dengan contoh berikut:

Package Id      Version      Commands       Manifest
-------------------------------------------------------------------------------------------
botsay          1.0.0        botsay         /home/name/repository/.config/dotnet-tools.json
dotnetsay       2.1.3        dotnetsay      /home/name/repository/.config/dotnet-tools.json

Seperti yang ditunjukkan dalam contoh sebelumnya, daftar menampilkan alat lokal. Untuk melihat alat global, gunakan --global opsi . Untuk melihat alat jalur alat, gunakan --tool-path opsi .

Untuk mencantumkan alat tertentu, gunakan perintah PACKAGE_ID> daftar <alat dotnet:

dotnet tool list dotnetsay

Output hanya akan mencantumkan alat tersebut jika diinstal, mirip dengan contoh berikut:

Package Id      Version      Commands       Manifest
-------------------------------------------------------------------------------------------
dotnetsay       2.1.3        dotnetsay      /home/name/repository/.config/dotnet-tools.json

Memanggil alat global

Untuk alat global, gunakan perintah alat dengan sendirinya. Misalnya, jika perintah adalah dotnetsay atau dotnet-doc, itulah yang Anda gunakan untuk memanggil alat global:

dotnetsay
dotnet-doc

Jika perintah dimulai dengan awalan dotnet-, cara alternatif untuk memanggil alat adalah dengan menggunakan dotnet perintah dan menghilangkan awalan perintah alat. Misalnya, jika perintahnya adalah dotnet-doc, perintah berikut memanggil alat:

dotnet doc

Namun, dalam skenario berikut, Anda tidak dapat menggunakan dotnet perintah untuk memanggil alat global:

  • Alat global dan alat lokal memiliki perintah yang sama yang diawali oleh dotnet-.
  • Anda ingin memanggil alat global dari direktori yang berada dalam cakupan untuk alat lokal.

Dalam skenario ini, dotnet doc dan dotnet dotnet-doc panggil alat lokal. Untuk memanggil alat global, gunakan perintah dengan sendirinya:

dotnet-doc

Memanggil alat jalur alat

Untuk memanggil alat global yang diinstal dengan menggunakan tool-path opsi , pastikan bahwa perintah tersedia seperti yang dijelaskan sebelumnya dalam artikel ini.

Memanggil alat lokal

Untuk memanggil alat lokal, Anda harus menggunakan dotnet perintah dari dalam direktori penginstalan. Anda dapat menggunakan formulir panjang (dotnet tool run <COMMAND_NAME>) atau formulir pendek (dotnet <COMMAND_NAME>), seperti yang diperlihatkan dalam contoh berikut:

dotnet tool run dotnetsay
dotnet dotnetsay

Jika perintah diawali oleh dotnet-, Anda dapat menyertakan atau menghilangkan awalan saat memanggil alat. Misalnya, jika perintahnya adalah dotnet-doc, salah satu contoh berikut memanggil alat lokal:

dotnet tool run dotnet-doc
dotnet dotnet-doc
dotnet doc

Memperbarui alat

Memperbarui alat melibatkan penghapusan instalasi dan menginstalnya kembali dengan versi stabil terbaru. Untuk memperbarui alat, gunakan perintah pembaruan alat dotnet dengan opsi yang sama dengan yang Anda gunakan untuk menginstal alat:

dotnet tool update --global <packagename>
dotnet tool update --tool-path <packagename>
dotnet tool update <packagename>

Untuk alat lokal, SDK mencari direktori saat ini dan direktori induk untuk menemukan file manifes pertama yang berisi ID paket. Jika tidak ada ID paket tersebut dalam file manifes apa pun, SDK menambahkan entri baru ke file manifes terdekat.

Menghapus instalan alat

Hapus instalan alat dengan menggunakan perintah hapus instalan alat dotnet dengan opsi yang sama dengan yang Anda gunakan untuk menginstal alat:

dotnet tool uninstall --global <packagename>
dotnet tool uninstall --tool-path <packagename>
dotnet tool uninstall <packagename>

Untuk alat lokal, SDK mencari direktori saat ini dan direktori induk untuk menemukan file manifes pertama yang berisi ID paket.

Dapatkan bantuan dan pemecahan masalah

Jika alat gagal menginstal atau menjalankan, lihat Memecahkan masalah penggunaan alat .NET. Anda bisa mendapatkan daftar perintah dan parameter yang tersedia dotnet tool dengan menggunakan --help parameter :

dotnet tool --help

Untuk mendapatkan instruksi penggunaan alat, masukkan salah satu perintah berikut atau lihat situs web alat:

<command> --help
dotnet <command> --help

Lihat juga