Skip to content

Added user-friendly installation instructions #2141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andyleejordan merged 3 commits into from
Mar 19, 2026
+5 −1
Merged

Added user-friendly installation instructions #2141

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a7fc2d
added user-friendly installation instructions
admercs Nov 13, 2025
4d0ce91
Apply suggestion from @Copilot
bergmeister Dec 2, 2025
186e150
Merge branch 'main' into readme_simple_install
bergmeister Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,11 @@ documentation for the latest release is published on on learn.microsoft.com.
## Installation

To install **PSScriptAnalyzer** from the PowerShell Gallery, see
[Installing PSScriptAnalyzer](https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/overview#installing-psscriptanalyzer).
[Installing PSScriptAnalyzer](https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/overview#installing-psscriptanalyzer) or simply open PowerShell in a Terminal and run:

```powershell
Install-Module -Name PSScriptAnalyzer

Copilot AI Nov 13, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The -Scope parameter should be specified for Install-Module to clarify where the module will be installed. Without it, PowerShell will attempt to install to AllUsers scope which requires elevated permissions, potentially causing the command to fail for non-admin users.

Consider updating to:

Install-Module -Name PSScriptAnalyzer -Scope CurrentUser

This allows users to install the module without requiring administrator privileges.

Suggested change
Install-Module -Name PSScriptAnalyzer
Install-Module -Name PSScriptAnalyzer -Scope CurrentUser

Copilot uses AI. Check for mistakes.

@sdwheeler sdwheeler Mar 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andyleejordan We should use PSResourceGet commands.

@andyleejordan andyleejordan Mar 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hopefully the linked instructions can be updated too.

```

To install **PSScriptAnalyzer** from source code:

Expand Down