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
+22-10Lines changed: 22 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,15 +25,27 @@ Ed Wilson (Scripting Guy) wrote a series on PSReadline, starting [here](http://b
25
25
26
26
##Installation
27
27
28
-
PSReadline builds are available in two places, GitHub and the PowerShell Gallery. The most recent builds will be published to the PowerShell Gallery until they are considered stable and then will be published on GitHub.
28
+
There are multiple ways to install PSReadline.
29
29
30
-
To install from the PowerShell Gallery, you will need a recent build of [WMF5](http://go.microsoft.com/fwlink/?LinkId=398175). If you have WMF5 already, you can just run `Install-Module PSReadline`.
30
+
### Install from PowerShellGallery (preferred)
31
31
32
-
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 Install-Module from PsGet is different than Install-Module with WMF5.
32
+
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).
33
33
34
-
Alternatively, 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.)
34
+
After installing PowerShellGet, you can simply run `Install-Module PSReadline`.
35
35
36
-
Next edit your profile to import the module. There are two common profile files commonly used and the instructions are slightly different for each.
36
+
If you are on Windows 10, PSReadline is already installed. At this time, you should not use Install-Module or Update-Module because there is not a newer version available for Windows 10.
37
+
38
+
### Install from GitHub (deprecated)
39
+
40
+
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.
41
+
42
+
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.
43
+
44
+
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.)
45
+
46
+
### Post Installation
47
+
48
+
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.
37
49
38
50
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:
39
51
@@ -54,9 +66,11 @@ In either case, you can create the appropriate file if you don't already have on
54
66
55
67
##Upgrading
56
68
57
-
If you installed with `PSGet` or WMF5, you can run `Update-Module PSReadLine`.
69
+
If you are on Windows 10, there is no upgrade available yet. When an upgrade is available, these instructions will be updated.
70
+
71
+
If you installed with `PSGet` or WMF5, you should exit from all instances of PowerShell that have loaded PSReadline, then run (from cmd.exe, or the Win+R run shortcut) `powershell -noprofile -command "Update-Module PSReadline"`.
58
72
59
-
If you've added it to your `$PROFILE`, when you run `Update-Module PSReadLine` you will get the following error
0 commit comments