PowerShell README

The project's README from github.com/PowerShell/PowerShell. As one markdown file: README.md.

logo PowerShell

Welcome to the PowerShell GitHub Community! PowerShell is a cross-platform (Windows, Linux, and macOS) automation and configuration tool/framework that works well with your existing tools and is optimized for dealing with structured data (e.g. JSON, CSV, XML, etc.), REST APIs, and object models. It includes a command-line shell, an associated scripting language, and a framework for processing cmdlets.

Windows PowerShell vs. PowerShell 7+

Although this repository started as a fork of the Windows PowerShell codebase, changes made in this repository are not ported back to Windows PowerShell 5.1. This also means that issues tracked here are only for PowerShell 7.x and higher. Windows PowerShell specific issues should be reported with the Feedback Hub app, by choosing "Apps > PowerShell" in the category.

New to PowerShell?

If you are new to PowerShell and want to learn more, we recommend reviewing the getting started documentation.

Get PowerShell

PowerShell is supported on Windows, macOS, and a variety of Linux platforms. For more information, see Installing PowerShell.

Upgrading PowerShell

For best results when upgrading, you should use the same install method you used when you first installed PowerShell. The update method is different for each platform and install method.

Community Dashboard

Dashboard with visualizations for community contributions and project status using PowerShell, Azure, and PowerBI.

For more information on how and why we built this dashboard, check out this blog post.

Discussions

GitHub Discussions is a feature to enable free and open discussions within the community for topics that are not related to code, unlike issues.

This is an experiment we are trying in our repositories, to see if it helps move discussions out of issues so that issues remain actionable by the team or members of the community. There should be no expectation that PowerShell team members are regular participants in these discussions. Individual PowerShell team members may choose to participate in discussions, but the expectation is that community members help drive discussions so that team members can focus on issues.

Create or join a discussion.

Chat

Want to chat with other members of the PowerShell community?

There are dozens of topic-specific channels on our community-driven PowerShell Virtual User Group, which you can join on:

Developing and Contributing

Want to contribute to PowerShell? Please start with the Contribution Guide to learn how to develop and contribute.

If you are developing .NET Core C# applications targeting PowerShell Core, check out our FAQ to learn more about the PowerShell SDK NuGet package.

Also, make sure to check out our PowerShell-RFC repository for request-for-comments (RFC) documents to submit and give comments on proposed and future designs.

Building PowerShell

Linux Windows macOS
Instructions Instructions Instructions

If you have any problems building PowerShell, please start by consulting the developer FAQ.

Downloading the Source Code

You can clone the repository:

git clone https://github.com/PowerShell/PowerShell.git

For more information, see working with the PowerShell repository.

Support

For support, see the Support Section.

PowerShell is licensed under the MIT license.

Docker Containers

[!Important] The PowerShell container images are now maintained by the .NET team. The containers at mcr.microsoft.com/powershell are currently not maintained.

License: By requesting and using the Container OS Image for Windows containers, you acknowledge, understand, and consent to the Supplemental License Terms available on Microsoft Artifact Registry.

Telemetry

Please visit our about_Telemetry topic to read details about telemetry gathered by PowerShell.

Governance

The governance policy for the PowerShell project is described the PowerShell Governance document.

Code of Conduct

Please see our Code of Conduct before participating in this project.

Security Policy

For any security issues, please see our Security Policy.

PowerShell (PowerShell/PowerShell)

Searching Database…

55.8K ·GitHub
PowerShell
What is this?PowerShell is a cross-platform automation and configuration tool/framework that includes a command-line shell, a scripting language, and a framework for processing cmdlets, optimized for structured data like JSON, CSV, XML and REST APIs.
Is this a different product from Windows PowerShell 5.1?Yes. This repo is PowerShell 7+, which started as a fork of the Windows PowerShell codebase, but changes here are not ported back to Windows PowerShell 5.1, and issues tracked here only apply to 7.x and higher.
How do I get PowerShell installed?PowerShell is supported on Windows, macOS, and various Linux distributions; see the 'Installing PowerShell' documentation for platform-specific install steps, and use the same install method again when upgrading.
If I have an issue with Windows PowerShell 5.1, can I report it here?No, this repository's issue tracker is only for PowerShell 7.x and higher; Windows PowerShell 5.1 issues must be reported through the Feedback Hub app instead.
Does PowerShell collect any usage data?Yes, PowerShell gathers telemetry data, with details documented in the aboutTelemetry topic.
Are there official Docker images?The containers previously published at mcr.microsoft.com/powershell are now maintained by the .NET team, not this project, and are currently not actively maintained by them either.
Where can I chat with the community?There are topic-specific channels on the community-driven PowerShell Virtual User Group available via Discord, IRC on Libera.Chat, and Slack.
Is there a place to propose new PowerShell features?Yes, the separate PowerShell-RFC repository is used for request-for-comments documents on proposed and future language/feature designs.
What are similar projects?winsw, acme.sh, NodePilot, zx, bashka, choco, aws-cli, gh-secure
Which topics is it in?scripting, powershell, c#, csharp, sysadmin, cli-tool, shell, command-line, hacktoberfest, devops, framework, terminal
Creator
PowerShell
Size
107.5 MB
Stars
55.8K
Updated
CommitOct 16Releasev7.6.7Oct 13
Age
10y
Commits · 90 Days