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
+11-14Lines changed: 11 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -37,27 +37,24 @@ There are multiple ways to install PSReadLine.
37
37
38
38
### Install from PowerShellGallery (preferred)
39
39
40
-
You will need PowerShellGet. It is included in Windows 10 and [WMF5](http://go.microsoft.com/fwlink/?LinkId=398175). If you are using PowerShell V3 or V4, you will need to install [PowerShellGet](https://www.microsoft.com/en-us/download/details.aspx?id=49186).
40
+
You will need PowerShellGet. It is included in Windows 10 and [WMF5](http://go.microsoft.com/fwlink/?LinkId=398175). If you are using PowerShell V3 or V4, you will need to install [PowerShellGet](https://docs.microsoft.com/powershell/gallery/installing-psget).
41
41
42
42
After installing PowerShellGet, you can simply run `Install-Module PSReadLine`.
43
43
44
44
If you are on Windows 10, PSReadLine is already installed. Windows 10 RTM and the November update have version 1.1, later builds have version 1.2 (which includes vi mode). See below for how to upgrade.
45
45
46
46
### Install from GitHub (deprecated)
47
47
48
-
With the preview release of PowerShellGet for PowerShell V3/V4, I am deprecating downloads from GitHub. I don't intend to update releases on GitHub, and may remove the release entirely from GitHub at some point.
49
-
50
-
To install the build from GitHub, you can install using [PsGet](http://psget.net) (very easy to install), and run `Install-Module PSReadLine`. Note that PsGet and PowerShellGet both have a Install-Module command, but they are very different despite having similar names and commands. PowerShellGet is implemented and supported by the PowerShell team at Microsoft, PsGet is a 3rd party tool that was a source of inspiration for PowerShellGet.
51
-
52
-
If you'd rather not use PsGet, you can just download the file [PSReadLine.zip](https://github.com/lzybkr/PSReadLine/releases/download/Latest/PSReadLine.zip) and extract the contents into your `C:\Users\[User]\Documents\WindowsPowerShell\modules\PSReadLine` folder. (You may have to create these directories if they don't exist.)
48
+
With the preview release of PowerShellGet for PowerShell V3/V4, downloads from GitHub are deprecated.
49
+
We don't intend to update releases on GitHub, and may remove the release entirely from GitHub at some point.
53
50
54
51
### Post Installation
55
52
56
53
Edit your profile to import the module. This step is optional with PowerShell V5 and greater. There are two common profile files commonly used and the instructions are slightly different for each.
57
54
58
55
The file `C:\Users\[User]\Documents\WindowsPowerShell\profile.ps1` is used for all hosts (e.g. the ISE and powershell.exe). If you already have this file, then you should add the following:
59
56
60
-
```
57
+
```powershell
61
58
if ($host.Name -eq 'ConsoleHost')
62
59
{
63
60
Import-Module PSReadLine
@@ -66,7 +63,7 @@ if ($host.Name -eq 'ConsoleHost')
66
63
67
64
Alternatively, the file `C:\Users\[User]\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1` is for powershell.exe only. Using this file, you can simply add:
68
65
69
-
```
66
+
```powershell
70
67
Import-Module PSReadLine
71
68
```
72
69
@@ -78,15 +75,14 @@ When running one of the suggested commands below, be sure to exit all instances
78
75
79
76
If you are using the version of PSReadLine that ships with Windows 10, you need to run: `powershell -noprofile -command "Install-Module PSReadLine -Force -SkipPublisherCheck"`.
80
77
81
-
If you've installed PSReadLine yourself from the PowerShell Gallery or with `PSGet` (this is less common on Windows 10), you can simply run: `powershell -noprofile -command "Update-Module PSReadLine"`.
78
+
If you've installed PSReadLine yourself from the PowerShell Gallery, you can simply run: `powershell -noprofile -command "Update-Module PSReadLine"`.
82
79
83
80
If you get an error like:
84
81
85
-
```
82
+
```powershell
86
83
Remove-Item : Cannot remove item
87
84
C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PSReadLine\Microsoft.PowerShell.PSReadLine.dll: Access to the path
88
85
'C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PSReadLine\Microsoft.PowerShell.PSReadLine.dll' is denied.
89
-
At C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PsGet\PsGet.psm1:1009 char:52
90
86
```
91
87
92
88
Then you didn't kill all the processes that loaded PSReadLine.
@@ -157,7 +154,7 @@ In this example, when you type a single quote or double quote, there are two thi
157
154
158
155
Note that with the handler written this way, it correctly handles Undo - both quotes will be undone with one undo.
159
156
160
-
The [sample profile file](https://github.com/lzybkr/PSReadLine/blob/master/PSReadLine/SamplePSReadLineProfile.ps1) has a bunch of great examples to check out. This file is included when PSReadLine is installed.
157
+
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.
161
158
162
159
See the public methods of [Microsoft.PowerShell.PSConsoleReadLine] to see what other built-in functionality you can modify.
163
160
@@ -193,8 +190,8 @@ After a successful build, the tests are automatically run.
193
190
194
191
## Change Log
195
192
196
-
The change log is available [here](https://github.com/lzybkr/PSReadLine/blob/master/PSReadLine/Changes.txt).
193
+
The change log is available [here](https://github.com/PowerShell/PSReadLine/blob/master/PSReadLine/Changes.txt).
197
194
198
195
## License
199
196
200
-
The license is available [here](https://github.com/lzybkr/PSReadLine/blob/master/PSReadLine/License.txt).
197
+
The license is available [here](https://github.com/PowerShell/PSReadLine/blob/master/PSReadLine/License.txt).
0 commit comments