Skip to content

Commit 8d22e25

Browse files
committed
Add Installation section to README
1 parent 6fd0a44 commit 8d22e25

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,33 @@ PSES is also available through the following editor extensions:
5151
- The [$psEditor API](docs/guide/extensions.md) enables scripting of the host editor
5252
- A full, Extension Terminal experience for interactive development and debugging
5353

54+
## Installation
55+
56+
PSES is implemented as a PowerShell module, but you cannot install it using
57+
PSResourceGet or `Install-Module`. To install PSES, follow the instructions in the
58+
sections below.
59+
60+
#### Automated Installation
61+
62+
Your text editor, IDE or LSP client may be able to install PSES for you. Check
63+
the relevant documentation.
64+
65+
#### Manual Installation
66+
67+
Download **PowerShellEditorServices.zip** from [GitHub Releases][pses-releases]
68+
and extract the contents to a directory of your choice.
69+
70+
The following script will download and extract **PowerShellEditorServices.zip**.
71+
You can copy and paste it into your PowerShell terminal.
72+
73+
```powershell
74+
$uri = 'https://api.github.com/repos/PowerShell/PowerShellEditorServices/releases/latest'
75+
irm $uri | % { iwr $_.assets.browser_download_url -OutFile PowerShellEditorServices.zip }
76+
Expand-Archive .\PowershellEditorservices.zip PowerShellEditorServices
77+
```
78+
79+
[pses-releases]: https://github.com/PowerShell/PowerShellEditorServices/releases
80+
5481
## Usage
5582

5683
If you're looking to integrate PowerShell Editor Services into your [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) compliant editor or client,

0 commit comments

Comments
 (0)