You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-21
Original file line number
Diff line number
Diff line change
@@ -30,34 +30,34 @@ It provides:
30
30
31
31
The "out of box" experience is meant to be very familiar to PowerShell users - there should be no need to learn any new key strokes.
32
32
33
-
Keith Hill wrote a great introduction to PSReadLine [here](http://rkeithhill.wordpress.com/2013/10/18/psreadline-a-better-line-editing-experience-for-the-powershell-console/).
33
+
Keith Hill wrote a great introduction to `PSReadLine`[here](http://rkeithhill.wordpress.com/2013/10/18/psreadline-a-better-line-editing-experience-for-the-powershell-console/).
34
34
35
-
Ed Wilson (Scripting Guy) wrote a series on PSReadLine, starting [here](http://blogs.technet.com/b/heyscriptingguy/archive/2014/06/16/the-search-for-a-better-powershell-console-experience.aspx).
35
+
Ed Wilson (Scripting Guy) wrote a series on `PSReadLine`, starting [here](http://blogs.technet.com/b/heyscriptingguy/archive/2014/06/16/the-search-for-a-better-powershell-console-experience.aspx).
36
36
37
37
## Installation
38
38
39
-
There are multiple ways to install PSReadLine.
39
+
There are multiple ways to install `PSReadLine`.
40
40
41
41
### Install from PowerShellGallery (preferred)
42
42
43
-
You will need the 1.6.0 or a higher version of [PowerShellGet](https://docs.microsoft.com/powershell/scripting/gallery/installing-psget) to install the latest prerelease version of PSReadLine.
43
+
You will need the `1.6.0` or a higher version of [`PowerShellGet`](https://docs.microsoft.com/powershell/scripting/gallery/installing-psget) to install the latest prerelease version of `PSReadLine`.
44
44
45
-
Windows PowerShell 5.1 ships an older version of PowerShellGet which doesn't support installing prerelease modules,
46
-
so Windows PowerShell users need to install the latest PowerShellGet (if not yet) by running the following commands from an elevated Windows PowerShell session:
45
+
Windows PowerShell 5.1 ships an older version of `PowerShellGet` which doesn't support installing prerelease modules,
46
+
so Windows PowerShell users need to install the latest `PowerShellGet` (if not yet) by running the following commands from an elevated Windows PowerShell session:
47
47
48
48
```powershell
49
49
Install-Module -Name PowerShellGet -Force
50
50
Exit
51
51
```
52
52
53
-
After installing PowerShellGet, you can simply run `Install-Module PSReadLine -AllowPrerelease -Force` to get the latest prerelease version of PSReadLine.
53
+
After installing `PowerShellGet`, you can simply run `Install-Module PSReadLine -AllowPrerelease -Force` to get the latest prerelease version of `PSReadLine`.
54
54
If you only want to get the latest stable version, run `Install-Module PSReadLine`.
55
55
56
56
>[!NOTE] Prerelease versions will have newer features and bug fixes, but may also introduce new issues.
57
57
58
-
If you are using Windows PowerShell on Windows 10 or using PowerShell 6+, PSReadLine is already installed.
59
-
Windows PowerShell on the latest Windows 10 has version `2.0.0-beta2` of PSReadLine.
60
-
PowerShell 6+ versions have the newer prerelease versions of PSReadLine.
58
+
If you are using Windows PowerShell on Windows 10 or using PowerShell 6+, `PSReadLine` is already installed.
59
+
Windows PowerShell on the latest Windows 10 has version `2.0.0-beta2` of `PSReadLine`.
60
+
PowerShell 6+ versions have the newer prerelease versions of `PSReadLine`.
61
61
62
62
### Install from GitHub (deprecated)
63
63
@@ -91,15 +91,15 @@ In either case, you can create the appropriate file if you don't already have on
91
91
## Upgrading
92
92
93
93
When running one of the suggested commands below, be sure to exit all instances of `powershell.exe`, `pwsh.exe` or `pwsh`,
94
-
then run the suggested command from `cmd.exe`, `powershell_ise.exe`, or via the `Win+R` shortcut to make sure PSReadLine isn't loaded.
94
+
then run the suggested command from `cmd.exe`, `powershell_ise.exe`, or via the `Win+R` shortcut to make sure `PSReadLine` isn't loaded.
95
95
96
-
If you are using the version of PSReadLine that ships with Windows PowerShell,
96
+
If you are using the version of `PSReadLine` that ships with Windows PowerShell,
97
97
you need to run: `powershell -noprofile -command "Install-Module PSReadLine -Force -SkipPublisherCheck -AllowPrerelease"`.
98
98
99
-
If you are using the version of PSReadLine that ships with PowerShell 6+ versions,
99
+
If you are using the version of `PSReadLine` that ships with PowerShell 6+ versions,
100
100
you need to run: `<path-to-pwsh-executable> -noprofile -command "Install-Module PSReadLine -Force -SkipPublisherCheck -AllowPrerelease"`.
101
101
102
-
If you've installed PSReadLine yourself from the PowerShell Gallery,
102
+
If you've installed `PSReadLine` yourself from the PowerShell Gallery,
103
103
you can simply run: `powershell -noprofile -command "Update-Module PSReadLine -AllowPrerelease"` or
'C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PSReadLine\Microsoft.PowerShell.PSReadLine.dll' is denied.
113
113
```
114
114
115
-
Then you didn't kill all the processes that loaded PSReadLine.
115
+
Then you didn't kill all the processes that loaded `PSReadLine`.
116
116
117
117
## Usage
118
118
@@ -134,9 +134,9 @@ To view the current key bindings:
134
134
Get-PSReadLineKeyHandler
135
135
```
136
136
137
-
There are many configuration options, see the options to Set-PSReadLineOption. PSReadLine has help for it's cmdlets as well as an about_PSReadLine topic - see those topics for more detailed help.
137
+
There are many configuration options, see the options to `Set-PSReadLineOption`. `PSReadLine` has help for it's cmdlets as well as an `about_PSReadLine` topic - see those topics for more detailed help.
138
138
139
-
To set your own custom keybindings, use the cmdlet Set-PSReadLineKeyHandler. For example, for a better history experience, try:
139
+
To set your own custom keybindings, use the cmdlet `Set-PSReadLineKeyHandler`. For example, for a better history experience, try:
@@ -181,9 +181,9 @@ In this example, when you type a single quote or double quote, there are two thi
181
181
182
182
Note that with the handler written this way, it correctly handles Undo - both quotes will be undone with one undo.
183
183
184
-
The [sample profile file](https://github.com/PowerShell/PSReadLine/blob/master/PSReadLine/SamplePSReadLineProfile.ps1) has a bunch of great examples to check out. This file is included when PSReadLine is installed.
184
+
The [sample profile file](https://github.com/PowerShell/PSReadLine/blob/master/PSReadLine/SamplePSReadLineProfile.ps1) has a bunch of great examples to check out. This file is included when `PSReadLine` is installed.
185
185
186
-
See the public methods of [Microsoft.PowerShell.PSConsoleReadLine] to see what other built-in functionality you can modify.
186
+
See the public methods of `[Microsoft.PowerShell.PSConsoleReadLine]` to see what other built-in functionality you can modify.
187
187
188
188
If you want to change the command line in some unimplmented way in your custom key binding, you can use the methods:
189
189
@@ -198,8 +198,8 @@ If you want to change the command line in some unimplmented way in your custom k
198
198
199
199
### Prerequisites
200
200
201
-
To build PSReadLine on Windows, Linux, or macOS, you must have [.NET Core SDK 2.1.400 or newer](https://www.microsoft.com/net/download) installed.
202
-
The build script also depends on [InvokeBuild](https://www.powershellgallery.com/packages/InvokeBuild) which can be installed using:
201
+
To build `PSReadLine` on Windows, Linux, or macOS, you must have [.NET Core SDK 2.1.400 or newer](https://www.microsoft.com/net/download) installed.
202
+
The build script also depends on [`InvokeBuild`](https://www.powershellgallery.com/packages/InvokeBuild) which can be installed using:
0 commit comments