Tutorial: Menginstal dan menggunakan alat lokal .NET menggunakan .NET CLI

Artikel
04/08/2023

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

Tutorial ini mengajarkan Anda cara menginstal dan menggunakan alat lokal. Anda menggunakan alat yang Anda buat di tutorial pertama seri ini.

Prasyarat

Selesaikan tutorial pertama dari seri ini.
Instal runtime .NET Core 2.1.

Untuk tutorial ini, Anda menginstal dan menggunakan alat yang menargetkan .NET Core 2.1, jadi Anda harus menginstal runtime pada komputer Anda. Untuk menginstal runtime 2.1, buka halaman unduhan .NET Core 2.1 dan temukan tautan penginstalan runtime di kolom Jalankan aplikasi - Runtime .

Membuat file manifes

Untuk menginstal alat hanya untuk akses lokal (untuk direktori dan subdirektori saat ini), alat harus ditambahkan ke file manifes.

Dari folder microsoft.botsay , navigasikan satu tingkat ke folder repositori :

cd ..

Buat file manifes dengan menjalankan perintah baru dotnet :

dotnet new tool-manifest

Output menunjukkan keberhasilan pembuatan file.

The template "Dotnet local tool manifest file" was created successfully.

File .config/dotnet-tools.json belum memiliki alat di dalamnya:

{
  "version": 1,
  "isRoot": true,
  "tools": {}
}

Alat yang tercantum dalam file manifes tersedia untuk direktori dan subdirektori saat ini. Direktori saat ini adalah direktori yang berisi direktori .config dengan file manifes.

Saat Anda menggunakan perintah CLI yang merujuk ke alat lokal, SDK mencari file manifes di direktori saat ini dan direktori induk. Jika menemukan file manifes, tetapi file tidak menyertakan alat yang direferensikan, file melanjutkan pencarian melalui direktori induk. Pencarian berakhir ketika menemukan alat yang dirujuk atau menemukan file manifes dengan isRoot diatur ke true.

Menginstal botsay sebagai alat lokal

Instal alat dari paket yang Anda buat di tutorial pertama:

dotnet tool install --add-source ./microsoft.botsay/nupkg microsoft.botsay

Perintah ini menambahkan alat ke file manifes yang Anda buat di langkah sebelumnya. Output perintah menunjukkan file manifes mana alat yang baru diinstal berada di:

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

File .config/dotnet-tools.json sekarang memiliki satu alat:

{
  "version": 1,
  "isRoot": true,
  "tools": {
    "microsoft.botsay": {
      "version": "1.0.0",
      "commands": [
        "botsay"
      ]
    }
  }
}

Menggunakan alat

Panggil alat dengan menjalankan dotnet tool run perintah dari folder repositori :

dotnet tool run botsay hello from the bot

Memulihkan alat lokal yang diinstal oleh orang lain

Anda biasanya menginstal alat lokal di direktori akar repositori. Setelah Anda memeriksa file manifes ke repositori, pengembang lain bisa mendapatkan file manifes terbaru. Untuk menginstal semua alat yang tercantum dalam file manifes, mereka dapat menjalankan satu dotnet tool restore perintah.

Buka file .config/dotnet-tools.json , dan ganti konten dengan JSON berikut:

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

Simpan perubahan Anda.

Membuat perubahan ini sama dengan mendapatkan versi terbaru dari repositori setelah orang lain menginstal paket dotnetsay untuk direktori proyek.

Jalankan perintah dotnet tool restore.

dotnet tool restore

Perintah menghasilkan output seperti contoh berikut:

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

Verifikasi bahwa alat tersedia:

dotnet tool list

Output adalah daftar paket dan perintah, mirip dengan contoh berikut:

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

Uji alat:

dotnet tool run dotnetsay hello from dotnetsay
dotnet tool run botsay hello from botsay

Memperbarui alat lokal

Versi alat dotnetsay lokal yang diinstal adalah 2.1.3. Gunakan perintah pembaruan alat dotnet untuk memperbarui alat ke versi terbaru.

dotnet tool update dotnetsay

Output menunjukkan nomor versi baru:

Tool 'dotnetsay' was successfully updated from version '2.1.3' to version '2.1.7'
(manifest file /home/name/repository/.config/dotnet-tools.json).

Perintah pembaruan menemukan file manifes pertama yang berisi ID paket dan memperbaruinya. Jika tidak ada ID paket tersebut dalam file manifes apa pun yang berada dalam lingkup pencarian, SDK menambahkan entri baru ke file manifes terdekat. Cakupan pencarian melalui direktori induk hingga file manifes dengan isRoot = true ditemukan.

Menghapus alat lokal

Hapus alat yang diinstal dengan menjalankan perintah hapus instalan alat dotnet :

dotnet tool uninstall microsoft.botsay

dotnet tool uninstall dotnetsay

Pecahkan masalah

Jika Anda mendapatkan pesan kesalahan saat mengikuti tutorial, lihat Memecahkan masalah penggunaan alat .NET.

Lihat juga

Untuk informasi selengkapnya, lihat alat .NET

Bagikan melalui