Bagikan melalui


Set-PSReadLineOption

Menyesuaikan perilaku pengeditan baris perintah di PSReadLine.

Sintaks

Default (Default)

Set-PSReadLineOption
    [-EditMode <EditMode>]
    [-ContinuationPrompt <string>]
    [-HistoryNoDuplicates]
    [-AddToHistoryHandler <Func[string,Object]>]
    [-CommandValidationHandler <Action[CommandAst]>]
    [-HistorySearchCursorMovesToEnd]
    [-MaximumHistoryCount <int>]
    [-MaximumKillRingCount <int>]
    [-ShowToolTips]
    [-ExtraPromptLineCount <int>]
    [-DingTone <int>]
    [-DingDuration <int>]
    [-BellStyle <BellStyle>]
    [-CompletionQueryItems <int>]
    [-WordDelimiters <string>]
    [-HistorySearchCaseSensitive]
    [-HistorySaveStyle <HistorySaveStyle>]
    [-HistorySavePath <string>]
    [-AnsiEscapeTimeout <int>]
    [-PromptText <string[]>]
    [-ViModeIndicator <ViModeStyle>]
    [-ViModeChangeHandler <scriptblock>]
    [-PredictionSource <PredictionSource>]
    [-PredictionViewStyle <PredictionViewStyle>]
    [-Colors <hashtable>]
    [-TerminateOrphanedConsoleApps]
    [<CommonParameters>]

Deskripsi

Set-PSReadLineOption Cmdlet menyesuaikan perilaku modul PSReadLine saat Anda mengedit baris perintah. Untuk melihat pengaturan PSReadLine , gunakan Get-PSReadLineOption.

Opsi yang diatur oleh perintah ini hanya berlaku untuk sesi saat ini. Untuk mempertahankan opsi apa pun, tambahkan opsi ke skrip profil. Untuk informasi selengkapnya, lihat about_Profiles dan Menyesuaikan lingkungan shell Anda.

Contoh

Contoh 1: Mengatur warna latar depan dan latar belakang

Contoh ini mengatur PSReadLine untuk menampilkan token Komentar dengan teks latar depan hijau pada latar belakang abu-abu. Dalam urutan escape yang digunakan dalam contoh, 32 mewakili warna latar depan dan 47 mewakili warna latar belakang.

Set-PSReadLineOption -Colors @{ "Comment"="`e[32;47m" }

Anda dapat memilih untuk hanya mengatur warna teks latar depan. Misalnya, warna teks latar depan hijau cerah untuk token Komentar : "Comment"="`e[92m".

Contoh 2: Mengatur gaya lonceng

Dalam contoh ini, PSReadLine akan merespons error atau kondisi yang memerlukan perhatian pengguna. BellStyle diatur untuk mengeluarkan bunyi bip yang terdengar pada 1221 Hz selama 60 ms.

Set-PSReadLineOption -BellStyle Audible -DingTone 1221 -DingDuration 60

Nota

Fitur ini mungkin tidak berfungsi di semua host di platform.

Contoh 3: Tetapkan beberapa opsi

Set-PSReadLineOption Dapat mengatur beberapa opsi dengan tabel hash.

$PSReadLineOptions = @{
    EditMode = "Emacs"
    HistoryNoDuplicates = $true
    HistorySearchCursorMovesToEnd = $true
    Colors = @{
        "Command" = "#8181f7"
    }
}
Set-PSReadLineOption @PSReadLineOptions

$PSReadLineOptions Tabel hash menetapkan kunci dan nilai. Set-PSReadLineOption menggunakan kunci dan nilai untuk @PSReadLineOptions memperbarui opsi PSReadLine .

Anda dapat melihat kunci dan nilai yang memasukkan nama tabel hash, $PSReadLineOptions pada baris perintah PowerShell.

Contoh 4: Mengatur beberapa opsi warna

Contoh ini menunjukkan cara mengatur lebih dari satu nilai warna dalam satu perintah.

Set-PSReadLineOption -Colors @{
  Command            = 'Magenta'
  Number             = 'DarkGray'
  Member             = 'DarkGray'
  Operator           = 'DarkGray'
  Type               = 'DarkGray'
  Variable           = 'DarkGreen'
  Parameter          = 'DarkGreen'
  ContinuationPrompt = 'DarkGray'
  Default            = 'DarkGray'
}

Contoh 5: Menetapkan nilai warna untuk beberapa jenis

Contoh ini menunjukkan tiga metode berbeda untuk cara mengatur warna token yang ditampilkan di PSReadLine.

Set-PSReadLineOption -Colors @{
 # Use a ConsoleColor enum
 "Error" = [ConsoleColor]::DarkRed

 # 24 bit color escape sequence
 "String" = "$([char]0x1b)[38;5;100m"

 # RGB value
 "Command" = "#8181f7"
}

Contoh 6: Gunakan ViModeChangeHandler untuk menampilkan perubahan mode Vi

Contoh ini memancarkan VT escape perubahan kursor sebagai respons terhadap perubahan mode Vi .

function OnViModeChange {
    if ($args[0] -eq 'Command') {
        # Set the cursor to a blinking block.
        Write-Host -NoNewline "`e[1 q"
    } else {
        # Set the cursor to a blinking line.
        Write-Host -NoNewline "`e[5 q"
    }
}
Set-PSReadLineOption -ViModeIndicator Script -ViModeChangeHandler $Function:OnViModeChange

Fungsi OnViModeChange mengatur opsi kursor untuk mode Vi: masukkan dan perintah. ViModeChangeHandler menggunakan Function: penyedia untuk mereferensikan OnViModeChange sebagai objek blok skrip.

Untuk informasi selengkapnya, lihat tentang_Penyedia.

Contoh 7: Gunakan HistoryHandler untuk memfilter perintah yang ditambahkan ke riwayat

Contoh berikut menunjukkan cara menggunakan AddToHistoryHandler untuk mencegah penyimpanan perintah git apa pun ke riwayat.

$ScriptBlock = {
    param ([string]$Line)

    if ($Line -match "^git") {
        return $false
    } else {
        return $true
    }
}

Set-PSReadLineOption -AddToHistoryHandler $ScriptBlock

Blokir skrip mengembalikan $false jika perintah dimulai dengan git. Ini memiliki efek yang sama dengan mengembalikan SkipAdding enum AddToHistory. Jika perintah tidak dimulai dengan git, handler mengembalikan $true dan PSReadLine menyimpan perintah dalam riwayat.

Contoh 8: Gunakan CommandValidationHandler untuk memvalidasi perintah sebelum dijalankan

Contoh ini menunjukkan cara menggunakan parameter CommandValidationHandler untuk menjalankan perintah validasi sebelum dijalankan. Contoh secara khusus memeriksa perintah git dengan sub perintah cmt dan menggantinya dengan nama commitlengkap . Dengan cara ini Anda dapat membuat alias singkat untuk sub-perintah.

# Load the namespace so you can use the [CommandAst] object type
using namespace System.Management.Automation.Language

Set-PSReadLineOption -CommandValidationHandler {
    param([CommandAst]$CommandAst)

    switch ($CommandAst.GetCommandName()) {
        'git' {
            $gitCmd = $CommandAst.CommandElements[1].Extent
            switch ($gitCmd.Text) {
                'cmt' {
                    [Microsoft.PowerShell.PSConsoleReadLine]::Replace(
                        $gitCmd.StartOffset, $gitCmd.EndOffset - $gitCmd.StartOffset, 'commit')
                }
            }
        }
    }
}
# This checks the validation script when you hit enter
Set-PSReadLineKeyHandler -Chord Enter -Function ValidateAndAcceptLine

Contoh 9: Menggunakan parameter PromptText

Ketika ada kesalahan penguraian, PSReadLine mengubah bagian dari prompt menjadi merah. Parameter PromptText memberi tahu PSReadLine bagian dari string prompt untuk membuat warna merah.

Misalnya, contoh berikut membuat perintah yang berisi jalur saat ini diikuti oleh karakter yang lebih besar dari (>) dan spasi.

function prompt { "PS $PWD> " }`
Set-PSReadLineOption -PromptText '> ' # change the '>' character red
Set-PSReadLineOption -PromptText '> ', 'X ' # replace the '>' character with a red 'X'

String pertama adalah bagian dari string prompt yang ingin Anda jadikan merah saat ada kesalahan penguraian. String kedua adalah string alternatif yang digunakan ketika ada kesalahan penguraian.

Parameter

-AddToHistoryHandler

Menentukan ScriptBlock yang mengontrol bagaimana perintah ditambahkan ke riwayat PSReadLine .

ScriptBlock menerima baris perintah sebagai input.

ScripBlock harus mengembalikan anggota enum AddToHistoryOption, nama string salah satu anggota tersebut, atau nilai boolean. Daftar di bawah ini menjelaskan kemungkinan nilai dan efeknya.

  • MemoryAndFile - Tambahkan perintah ke file riwayat dan sesi saat ini.
  • MemoryOnly - Tambahkan perintah ke riwayat untuk sesi saat ini saja.
  • SkipAdding - Jangan tambahkan perintah ke file riwayat untuk sesi saat ini.
  • $false - Sama seperti jika nilainya adalah SkipAdding.
  • $true - Sama seperti jika nilainya adalah MemoryAndFile.

Properti parameter

Jenis:

Func<T,TResult>[System.String,System.Object]

Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-AnsiEscapeTimeout

Opsi ini khusus untuk Windows saat input dialihkan, misalnya, saat berjalan di bawah tmux atau screen.

Dengan input yang dialihkan di Windows, banyak tombol dikirim sebagai urutan karakter yang dimulai dengan karakter escape. Tidak mungkin untuk membedakan antara satu karakter pelarian yang diikuti oleh lebih banyak karakter dan urutan pelarian yang valid.

Asumsinya adalah bahwa terminal dapat mengirim karakter lebih cepat daripada jenis pengguna. PSReadLine menunggu batas waktu ini sebelum menyimpulkan bahwa mereka telah menerima urutan escape lengkap.

Jika Anda melihat karakter acak atau tidak terduga saat mengetik, Anda dapat menyesuaikan batas waktu ini.

Properti parameter

Jenis:Int32
Nilai default:100
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-BellStyle

Menentukan bagaimana PSReadLine merespons berbagai kesalahan dan kondisi ambigu.

Nilai yang valid adalah sebagai berikut:

  • Terdengar: Bunyi bip pendek.
  • Visual: Teks berkedip sebentar.
  • Tidak ada: Tidak ada umpan balik.

Properti parameter

Jenis:BellStyle
Nilai default:Audible
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Colors

Parameter Colors menentukan berbagai warna yang digunakan oleh PSReadLine.

Argumen adalah tabel hash di mana kunci menentukan elemen dan nilai menentukan warna. Untuk informasi selengkapnya, lihat about_Hash_Tables.

Warna dapat berupa nilai dari ConsoleColor, misalnya [ConsoleColor]::Red, atau urutan escape ANSI yang valid. Urutan escape yang valid tergantung pada terminal Anda. Di PowerShell 5.0, contoh urutan escape untuk teks merah adalah $([char]0x1b)[91m. Di PowerShell 6 dan yang lebih baru, urutan escape yang sama adalah `e[91m. Anda dapat menentukan urutan escape lainnya termasuk jenis berikut:

Dua pengaturan warna ditambahkan untuk mendukung kustomisasi ListView di PSReadLine 2.2.0:

  • ListPredictionColor - atur warna untuk karakter utama > dan nama sumber berikutnya, seperti [History]. Secara default, ini menggunakan DarkYellow sebagai warna latar depan.

  • ListPredictionSelectedColor - atur warna untuk menunjukkan item daftar dipilih. Secara default, ini menggunakan DarkBlack sebagai warna latar belakang.

  • 256 warna

  • Warna 24-bit

  • Latar depan, latar belakang, atau keduanya

  • Terbalik, tebal

Untuk informasi selengkapnya tentang kode warna ANSI, lihat artikel Wikipedia KODE escape ANSI.

Kunci yang valid meliputi:

  • ContinuationPrompt: Warna prompt kelanjutan.
  • Penekanan: Warna penekanan. Misalnya, teks yang cocok saat riwayat penelusuran.
  • Kesalahan: Warna kesalahan. Misalnya, dalam prompt.
  • Pilihan: Warna untuk menyorot pilihan menu atau teks yang dipilih.
  • Default: Warna token default.
  • Komentar: Warna token komentar.
  • Kata kunci: Warna token kata kunci.
  • String: Warna token string.
  • Operator: Warna token operator.
  • Variabel: Warna token variabel.
  • Perintah: Warna token perintah.
  • Parameter: Warna token parameter.
  • Jenis: Jenis warna token.
  • Nomor: Warna token angka.
  • Anggota: Warna token nama anggota.
  • InlinePrediction: Warna untuk tampilan sebaris saran prediktif.
  • ListPrediction: Warna untuk karakter utama > dan nama sumber prediksi.
  • ListPredictionSelected: Warna untuk prediksi yang dipilih dalam tampilan daftar.

Properti parameter

Jenis:Hashtable
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-CommandValidationHandler

Menentukan ScriptBlock yang dipanggil dari ValidateAndAcceptLine. Jika pengecualian dilemparkan, validasi gagal dan kesalahan dilaporkan.

Sebelum melemparkan pengecualian, penangan validasi dapat menempatkan kursor pada titik kesalahan untuk mempermudah perbaikan. Handler validasi juga dapat mengubah baris perintah untuk memperbaiki kesalahan tipografi umum.

ValidateAndAcceptLine digunakan untuk menghindari kekacauan riwayat Anda dengan perintah yang tidak dapat berfungsi.

Properti parameter

Jenis:

Action<T>[CommandAst]

Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-CompletionQueryItems

Menentukan jumlah maksimum item penyelesaian yang ditampilkan tanpa diminta.

Jika jumlah item yang akan ditampilkan lebih besar dari nilai ini, PSReadLine meminta ya/tidak sebelum menampilkan item penyelesaian.

Properti parameter

Jenis:Int32
Nilai default:100
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ContinuationPrompt

Menentukan string yang ditampilkan di awal baris berikutnya saat input multi-baris dimasukkan. Defaultnya adalah tanda ganda lebih besar dari tanda (>>). String kosong valid.

Properti parameter

Jenis:String
Nilai default:>>
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DingDuration

Menentukan durasi bunyi bip saat BellStyle diatur ke Audible.

Properti parameter

Jenis:Int32
Nilai default:50ms
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DingTone

Menentukan nada dalam Hertz (Hz) bunyi bip saat BellStyle diatur ke Audible.

Properti parameter

Jenis:Int32
Nilai default:1221
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-EditMode

Menentukan mode pengeditan baris perintah. Menggunakan parameter ini mengatur ulang pengikatan tombol apa pun yang diatur oleh Set-PSReadLineKeyHandler.

Nilai yang valid adalah sebagai berikut:

  • Windows: Pengikatan tombol meniru PowerShell, cmd, dan Visual Studio. (default pada Windows)
  • Emacs: Pengikatan tombol meniru Bash atau Emacs. (default pada platform non-Windows)
  • Vi: Pengikatan tombol meniru Vi.

Gunakan Get-PSReadLineKeyHandler untuk melihat pengikatan tombol untuk EditMode yang saat ini dikonfigurasi.

Properti parameter

Jenis:EditMode
Nilai default:Windows
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ExtraPromptLineCount

Menentukan jumlah baris tambahan.

Jika perintah Anda mencakup lebih dari satu baris, tentukan nilai untuk parameter ini. Gunakan opsi ini jika Anda ingin baris tambahan tersedia saat PSReadLine menampilkan prompt setelah menampilkan beberapa output. Misalnya, PSReadLine mengembalikan daftar penyelesaian.

Opsi ini diperlukan lebih sedikit daripada versi PSReadLine sebelumnya, tetapi berguna saat fungsi digunakan InvokePrompt .

Properti parameter

Jenis:Int32
Nilai default:0
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-HistoryNoDuplicates

Opsi ini mengontrol perilaku penarikan balik. Perintah duplikat masih ditambahkan ke file riwayat. Saat opsi ini diatur, hanya pemanggilan terbaru yang muncul saat meningat perintah. Perintah berulang ditambahkan ke riwayat untuk mempertahankan urutan selama penarikan. Namun, Anda biasanya tidak ingin melihat perintah beberapa kali saat mengingat atau mencari riwayat.

Secara default, properti HistoryNoDuplicates dari objek PSConsoleReadLineOptions global diatur ke True. Untuk mengubah nilai properti, Anda harus menentukan nilai SwitchParameter sebagai berikut: -HistoryNoDuplicates:$false. Anda dapat mengatur kembali dengan True hanya menggunakan SwitchParameter, -HistoryNoDuplicates.

Dengan menggunakan perintah berikut, Anda dapat mengatur nilai properti secara langsung:

(Get-PSReadLineOption).HistoryNoDuplicates = $false

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-HistorySavePath

Menentukan jalur ke file tempat riwayat disimpan. Komputer yang menjalankan platform Windows atau non-Windows menyimpan file di lokasi yang berbeda. Nama file disimpan dalam variabel $($Host.Name)_history.txt, misalnya ConsoleHost_history.txt.

Jika Anda tidak menggunakan parameter ini, jalur defaultnya adalah sebagai berikut:

Windows

  • $Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine\$($Host.Name)_history.txt

non-Windows

  • $Env:XDG_DATA_HOME/powershell/PSReadLine/$($Host.Name)_history.txt
  • $HOME/.local/share/powershell/PSReadLine/$($Host.Name)_history.txt

Properti parameter

Jenis:String
Nilai default:A file named $($Host.Name)_history.txt in $Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine on Windows and $Env:XDG_DATA_HOME/powershell/PSReadLine or $HOME/.local/share/powershell/PSReadLine on non-Windows platforms
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-HistorySaveStyle

Menentukan cara PSReadLine menyimpan riwayat.

Nilai yang valid adalah sebagai berikut:

  • SaveIncrementally: Simpan riwayat setelah setiap perintah dijalankan dan bagikan di beberapa instans PowerShell.
  • SaveAtExit: Tambahkan file riwayat saat PowerShell keluar.
  • SaveNothing: Jangan gunakan file riwayat.

Nota

Jika Anda mengatur HistorySaveStyle ke SaveNothing lalu mengaturnya ke SaveIncrementally nanti dalam sesi yang sama, PSReadLine menyimpan semua perintah yang sebelumnya dijalankan dalam sesi.

Properti parameter

Jenis:HistorySaveStyle
Nilai default:SaveIncrementally
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-HistorySearchCaseSensitive

Menentukan bahwa pencarian riwayat peka huruf besar/kecil dalam fungsi seperti ReverseSearchHistory atau HistorySearchBackward.

Secara default, properti HistorySearchCaseSensitive dari objek PSConsoleReadLineOptions global diatur ke False. Menggunakan SwitchParameter ini mengatur nilai properti ke True. Untuk mengubah nilai properti kembali, Anda harus menentukan nilai SwitchParameter sebagai berikut: -HistorySearchCaseSensitive:$false.

Dengan menggunakan perintah berikut, Anda dapat mengatur nilai properti secara langsung:

(Get-PSReadLineOption).HistorySearchCaseSensitive = $false

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-HistorySearchCursorMovesToEnd

Menunjukkan bahwa kursor bergerak ke akhir perintah yang Anda muat dari riwayat dengan menggunakan pencarian. Saat parameter ini diatur ke $false, kursor tetap pada posisi saat Anda menekan panah atas atau bawah.

Secara default, properti HistorySearchCursorMovesToEnd dari objek PSConsoleReadLineOptions global diatur ke False. Dengan menggunakan SwitchParameter ini, atur nilai properti ke True. Untuk mengubah nilai properti kembali, Anda harus menentukan nilai SwitchParameter sebagai berikut: -HistorySearchCursorMovesToEnd:$false.

Dengan menggunakan perintah berikut, Anda dapat mengatur nilai properti secara langsung:

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $false

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-MaximumHistoryCount

Menentukan jumlah maksimum perintah yang akan disimpan dalam riwayat PSReadLine .

Riwayat PSReadLine terpisah dari riwayat PowerShell.

Properti parameter

Jenis:Int32
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-MaximumKillRingCount

Menentukan jumlah maksimum item yang disimpan dalam cincin pembunuhan.

Properti parameter

Jenis:Int32
Nilai default:10
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-PredictionSource

Menentukan sumber untuk PSReadLine untuk mendapatkan saran prediktif.

Nilai yang valid adalah:

  • None - nonaktifkan fitur IntelliSense prediktif (default).
  • Riwayat - aktifkan fitur IntelliSense prediktif dan gunakan riwayat PSReadLine sebagai satu-satunya sumber.
  • Plugin - aktifkan fitur IntelliSense prediktif dan gunakan plugin (CommandPrediction) sebagai satu-satunya sumber. Nilai ini ditambahkan di PSReadLine 2.2.0
  • HistoryAndPlugin - aktifkan fitur IntelliSense prediktif dan gunakan riwayat dan plugin sebagai sumbernya. Nilai ini ditambahkan di PSReadLine 2.2.0

Properti parameter

Jenis:Microsoft.PowerShell.PredictionSource
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-PredictionViewStyle

Mengatur gaya untuk tampilan teks prediktif. Defaultnya adalah InlineView.

  • InlineView - gaya seperti yang ada saat ini, mirip seperti pada fish shell dan zsh. (default)
  • ListView - saran dirender dalam daftar drop-down, dan pengguna dapat memilih menggunakan UpArrow dan DownArrow.

Parameter ini ditambahkan dalam PSReadLine 2.2.0

Properti parameter

Jenis:Microsoft.PowerShell.PredictionViewStyle
Nilai default:InlineView
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-PromptText

Parameter ini menetapkan nilai properti PromptText . Nilai defaultnya adalah "> ".

PSReadLine menganalisis fungsi prompt Anda untuk menentukan cara mengubah hanya warna bagian dari prompt Anda. Analisis ini tidak 100% dapat diandalkan. Gunakan opsi ini jika PSReadLine mengubah prompt Anda dengan cara yang tidak terduga. Sertakan spasi kosong di belakang.

Nilai parameter ini dapat berupa string tunggal atau array dari dua string. String pertama adalah bagian dari string prompt yang ingin Anda ubah menjadi merah saat ada kesalahan penguraian. String kedua adalah string alternatif yang digunakan ketika ada kesalahan penguraian.

Properti parameter

Jenis:

String[]

Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ShowToolTips

Saat menampilkan kemungkinan penyelesaian, tooltip ditampilkan dalam daftar penyelesaian.

Opsi ini diaktifkan secara default. Opsi ini tidak diaktifkan secara default di PSReadLine versi sebelumnya. Untuk menonaktifkan, atur opsi ini ke $false.

Parameter dan opsi ini ditambahkan di PSReadLine 2.3.4.

Secara default, properti ShowToolTips dari objek PSConsoleReadLineOptions global diatur ke True. Menggunakan SwitchParameter ini mengatur nilai properti ke True. Untuk mengubah nilai properti, Anda harus menentukan nilai SwitchParameter sebagai berikut: -ShowToolTips:$false.

Dengan menggunakan perintah berikut, Anda dapat mengatur nilai properti secara langsung:

(Get-PSReadLineOption).ShowToolTips = $false

Properti parameter

Jenis:SwitchParameter
Nilai default:True
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-TerminateOrphanedConsoleApps

Parameter ini mengatur opsi TerminateOrphanedConsoleApps ke $true.

Di Windows, ketika Anda menekan Ctrl+c untuk mengakhiri proses, setiap proses yang dilampirkan ke konsol menerima sinyal penghentian, bukan hanya shell aktif. Terkadang, ketika shell telah meluncurkan beberapa pohon besar proses anak, (bayangkan sistem build, misalnya) beberapa proses mungkin keluar, meninggalkan beberapa proses secara bersamaan mencoba mengonsumsi input konsol.

Saat mengatur opsi TerminateOrphanedConsoleApps ke $true, PSReadLine merekam daftar proses yang saat ini dilampirkan ke konsol. Setelah itu, setiap kali PSReadLine berjalan, PSReadLine akan mendapatkan daftar proses baru yang melekat pada konsol, dan mengakhiri proses yang tidak ada dalam daftar asli.

Parameter dan opsi ini ditambahkan di PSReadLine 2.3.4.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ViModeChangeHandler

Ketika ViModeIndicator diatur ke Script, blok skrip yang disediakan akan dipanggil setiap kali mode berubah. Blok skrip disediakan satu argumen jenis ViMode.

Parameter ini diperkenalkan di PowerShell 7.

Properti parameter

Jenis:ScriptBlock
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ViModeIndicator

Opsi ini mengatur indikator visual untuk mode Vi saat ini. Mode sisipkan atau mode perintah.

Nilai yang valid adalah sebagai berikut:

  • Tidak ada: Tidak ada indikator.
  • Prompt: Prompt berubah warna.
  • Kursor: Kursor berubah ukuran.
  • Skrip: Teks yang ditentukan pengguna dicetak.

Properti parameter

Jenis:ViModeStyle
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-WordDelimiters

Menentukan karakter yang membatasi kata untuk fungsi seperti ForwardWord atau KillWord.

Properti parameter

Jenis:String
Nilai default:;:,.[]{}()/\|^&*-=+'"---
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output

None

Cmdlet ini tidak mengembalikan output.