2017-03-21 22:20:11 +00:00
# ![logo][] PowerShell
2015-07-01 22:06:29 +00:00
2016-08-18 15:55:00 +00:00
Welcome to the PowerShell GitHub Community!
2017-07-08 22:20:09 +00:00
PowerShell Core 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.
2016-07-27 21:47:03 +00:00
2018-02-03 02:35:59 +00:00
[logo]: https://raw.githubusercontent.com/PowerShell/PowerShell/master/assets/ps_black_64.svg?sanitize=true
2016-03-30 22:13:29 +00:00
2017-07-08 22:20:09 +00:00
## Windows PowerShell vs PowerShell Core
Although this repo started as a fork of the Windows PowerShell code base, changes made in this repo do not make their way back to Windows PowerShell 5.1 automatically.
This also means that issues tracked here are only for PowerShell Core 6.0.
Windows PowerShell specific issues should be opened on [UserVoice][].
[UserVoice]: https://windowsserver.uservoice.com/forums/301869-powershell
2017-03-21 22:20:11 +00:00
## New to PowerShell?
2016-03-30 22:13:29 +00:00
2016-07-27 21:47:03 +00:00
If you are new to PowerShell and would like to learn more, we recommend reviewing the [getting started][] documentation.
2016-01-22 19:36:23 +00:00
2017-11-06 18:29:49 +00:00
[getting started]: https://github.com/PowerShell/PowerShell/tree/master/docs/learning-powershell
2016-03-30 19:06:57 +00:00
2017-03-21 22:20:11 +00:00
## Get PowerShell
2016-03-30 22:13:29 +00:00
2016-07-27 21:47:03 +00:00
You can download and install a PowerShell package for any of the following platforms.
2018-03-23 23:48:24 +00:00
| Supported Platform | Downloads (stable) | Downloads (preview) | How to Install |
| -------------------------------------------| ------------------------| ----------------------| ------------------------------|
| [Windows (x64)][corefx-win] | [.msi][rl-windows-64] | [.msi][pv-windows-64] | [Instructions][in-windows] |
| [Windows (x86)][corefx-win] | [.msi][rl-windows-86] | [.msi][pv-windows-86] | [Instructions][in-windows] |
| [Ubuntu 17.04][corefx-linux] | [.deb][rl-ubuntu17] | [.deb][pv-ubuntu17] | [Instructions][in-ubuntu17] |
| [Ubuntu 16.04][corefx-linux] | [.deb][rl-ubuntu16] | [.deb][pv-ubuntu16] | [Instructions][in-ubuntu16] |
| [Ubuntu 14.04][corefx-linux] | [.deb][rl-ubuntu14] | [.deb][pv-ubuntu14] | [Instructions][in-ubuntu14] |
| [Debian 8.7+][corefx-linux] | [.deb][rl-debian8] | [.deb][pv-debian8] | [Instructions][in-deb8] |
| [Debian 9][corefx-linux] | [.deb][rl-debian9] | [.deb][pv-debian9] | [Instructions][in-deb9] |
| [CentOS 7][corefx-linux] | [.rpm][rl-centos] | [.rpm][pv-centos] | [Instructions][in-centos] |
| [Red Hat Enterprise Linux 7][corefx-linux] | [.rpm][rl-centos] | [.rpm][pv-centos] | [Instructions][in-rhel7] |
| [OpenSUSE 42.2][corefx-linux] | [.rpm][rl-centos] | [.rpm][pv-centos] | [Instructions][in-opensuse422]|
| [Fedora 25][corefx-linux] | [.rpm][rl-centos] | [.rpm][pv-centos] | [Instructions][in-fedora25] |
| [Fedora 26][corefx-linux] | [.rpm][rl-centos] | [.rpm][pv-centos] | [Instructions][in-fedora26] |
| [macOS 10.12+][corefx-macos] | [.pkg][rl-macos] | [.pkg][pv-macos] | [Instructions][in-macos] |
| Docker | | | [Instructions][in-docker] |
2017-12-14 21:15:19 +00:00
You can download and install a PowerShell package for any of the following platforms, **which are supported by the community.**
2018-03-23 23:48:24 +00:00
| Platform | Downloads (stable) | Downloads (preview) | How to Install |
| -------------------------| ------------------------| ----------------------------- | ------------------------------|
| Arch Linux | | | [Instructions][in-archlinux] |
| Kali Linux | [.deb][rl-ubuntu16] | [.deb][pv-ubuntu16] | [Instructions][in-kali] |
| Many Linux distributions | [.AppImage][rl-ai] | | [Instructions][in-appimage] |
2017-10-24 18:13:17 +00:00
You can also download the PowerShell binary archives for Windows, macOS and Linux.
2018-03-23 23:48:24 +00:00
| Platform | Downloads (stable) | Downloads (preview) | How to Install |
| ------------------------------------| ------------------------------------------------ | ------------------------------------------------| -----------------------------------------------|
| Windows | [32-bit][rl-winx86-zip]/[64-bit][rl-winx64-zip] | [32-bit][pv-winx86-zip]/[64-bit][pv-winx64-zip] | [Instructions][in-windows-zip] |
| macOS | [64-bit][rl-macos-tar] | [64-bit][pv-macos-tar] | [Instructions][in-tar] |
| Linux | [64-bit][rl-linux-tar] | [64-bit][pv-linux-tar] | [Instructions][in-tar] |
| Windows (arm) **Experimental** | [32-bit][rl-winarm]/[64-bit][rl-winarm64] | [32-bit][pv-winarm]/[64-bit][pv-winarm64] | [Instructions][in-windows-zip] |
| Raspbian (Stretch) **Experimental** | [.tgz][rl-raspbian] | [.tgz][pv-raspbian] | [Instructions][in-raspbian] |
2017-12-14 21:15:19 +00:00
2018-03-15 18:41:01 +00:00
[rl-windows-64]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/PowerShell-6.0.2-win-x64.msi
[rl-windows-86]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/PowerShell-6.0.2-win-x86.msi
[rl-ubuntu17]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/powershell_6.0.2-1.ubuntu.17.04_amd64.deb
[rl-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/powershell_6.0.2-1.ubuntu.16.04_amd64.deb
[rl-ubuntu14]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/powershell_6.0.2-1.ubuntu.14.04_amd64.deb
[rl-debian8]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/powershell_6.0.2-1.debian.8_amd64.deb
[rl-debian9]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/powershell_6.0.2-1.debian.9_amd64.deb
[rl-centos]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/powershell-6.0.2-1.rhel.7.x86_64.rpm
2018-03-23 23:48:24 +00:00
[rl-ai]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.1/PowerShell-6.0.1-x86_64.AppImage
2018-03-15 18:41:01 +00:00
[rl-macos]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/powershell-6.0.2-osx.10.12-x64.pkg
[rl-winarm]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/PowerShell-6.0.2-win-arm32.zip
[rl-winarm64]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/PowerShell-6.0.2-win-arm64.zip
[rl-winx86-zip]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/PowerShell-6.0.2-win-x86.zip
[rl-winx64-zip]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/PowerShell-6.0.2-win-x64.zip
[rl-macos-tar]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/powershell-6.0.2-osx-x64.tar.gz
[rl-linux-tar]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/powershell-6.0.2-linux-x64.tar.gz
[rl-raspbian]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.2/powershell-6.0.2-linux-arm32.tar.gz
2016-07-27 21:47:03 +00:00
2018-04-27 00:54:42 +00:00
[pv-windows-64]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/PowerShell-6.1.0-preview.2-win-x64.msi
[pv-windows-86]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/PowerShell-6.1.0-preview.2-win-x86.msi
2018-04-27 22:53:50 +00:00
[pv-ubuntu17]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/powershell_6.1.0-preview.2-1.ubuntu.17.04_amd64.deb
[pv-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/powershell_6.1.0-preview.2-1.ubuntu.16.04_amd64.deb
[pv-ubuntu14]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/powershell_6.1.0-preview.2-1.ubuntu.14.04_amd64.deb
[pv-debian8]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/powershell_6.1.0-preview.2-1.debian.8_amd64.deb
[pv-debian9]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/powershell_6.1.0-preview.2-1.debian.9_amd64.deb
[pv-centos]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/powershell-6.1.0-preview.2-1.rhel.7.x86_64.rpm
2018-04-27 00:54:42 +00:00
[pv-macos]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/powershell-6.1.0-preview.2-osx.10.12-x64.pkg
[pv-winarm]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/PowerShell-6.1.0-preview.2-win-arm32.zip
[pv-winarm64]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/PowerShell-6.1.0-preview.2-win-arm64.zip
[pv-winx86-zip]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/PowerShell-6.1.0-preview.2-win-x86.zip
[pv-winx64-zip]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/PowerShell-6.1.0-preview.2-win-x64.zip
[pv-macos-tar]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/powershell-6.1.0-preview.2-osx-x64.tar.gz
[pv-linux-tar]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/powershell-6.1.0-preview.2-linux-x64.tar.gz
[pv-raspbian]: https://github.com/PowerShell/PowerShell/releases/download/v6.1.0-preview.2/powershell-6.1.0-preview.2-linux-arm32.tar.gz
2018-03-23 23:48:24 +00:00
2017-11-06 18:29:49 +00:00
[installation]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation
[in-windows]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/windows.md#msi
[in-ubuntu14]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#ubuntu-1404
[in-ubuntu16]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#ubuntu-1604
[in-ubuntu17]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#ubuntu-1704
[in-deb8]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#debian-8
[in-deb9]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#debian-9
[in-centos]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#centos-7
[in-rhel7]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#red-hat-enterprise-linux-rhel-7
[in-opensuse422]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#opensuse-422
[in-fedora25]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#fedora-25
[in-fedora26]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#fedora-26
[in-archlinux]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#arch-linux
[in-appimage]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#linux-appimage
2018-01-09 22:55:51 +00:00
[in-macos]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/macos.md
2017-11-06 18:29:49 +00:00
[in-docker]: https://github.com/PowerShell/PowerShell/tree/master/docker
[in-kali]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#kali
[in-windows-zip]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/windows.md#zip
[in-tar]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#binary-archives
2017-11-27 18:52:25 +00:00
[in-raspbian]: https://github.com/PowerShell/PowerShell/tree/master/docs/installation/linux.md#raspbian
2017-12-14 21:15:19 +00:00
[corefx-win]:https://github.com/dotnet/core/blob/master/release-notes/2.0/2.0-supported-os.md#windows
[corefx-linux]:https://github.com/dotnet/core/blob/master/release-notes/2.0/2.0-supported-os.md#linux
[corefx-macos]:https://github.com/dotnet/core/blob/master/release-notes/2.0/2.0-supported-os.md#macos
2016-06-24 18:18:01 +00:00
2016-08-05 21:10:42 +00:00
To install a specific version, visit [releases ](https://github.com/PowerShell/PowerShell/releases ).
2016-07-13 22:59:08 +00:00
2017-03-21 22:20:11 +00:00
## Community Dashboard
2017-03-07 01:28:42 +00:00
[Dashboard ](https://aka.ms/psgithubbi ) 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 ](https://blogs.msdn.microsoft.com/powershell/2017/01/31/powershell-open-source-community-dashboard/ ).
2017-03-21 22:20:11 +00:00
## Chat Room
2016-08-18 15:44:07 +00:00
Want to chat with other members of the PowerShell community?
2016-08-30 02:30:23 +00:00
We have a Gitter Room which you can join below.
2016-08-18 15:44:07 +00:00
[](https://gitter.im/PowerShell/PowerShell?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2017-03-21 22:20:11 +00:00
There is also the community driven PowerShell Slack Team which you can sign up for at [Slack Sign up].
2016-08-30 02:30:23 +00:00
2017-03-21 22:20:11 +00:00
[Slack Sign up]: http://slack.poshcode.org
2017-06-07 23:25:32 +00:00
## Add-ons and libraries
[Awesome PowerShell ](https://github.com/janikvonrotz/awesome-powershell ) is a great curated list of add-ons and resources.
2017-03-21 22:20:11 +00:00
## Building the Repository
2016-07-27 21:47:03 +00:00
2016-08-26 19:08:50 +00:00
| Linux | Windows | macOS |
2016-07-27 21:47:03 +00:00
|--------------------------|----------------------------|------------------------|
2016-08-26 19:08:50 +00:00
| [Instructions][bd-linux] | [Instructions][bd-windows] | [Instructions][bd-macOS] |
2016-07-27 21:47:03 +00:00
2016-07-28 19:45:31 +00:00
If you have any problems building, please consult the developer [FAQ][].
### Build status of master branches
2016-08-26 19:08:50 +00:00
| AppVeyor (Windows) | Travis CI (Linux / macOS) |
2016-07-28 19:45:31 +00:00
|--------------------------|--------------------------|
| [![av-image][]][av-site] | [![tv-image][]][tv-site] |
2016-10-12 20:34:24 +00:00
### Build status of nightly builds
2017-09-05 18:11:47 +00:00
| AppVeyor (Windows) | Travis CI (Linux) | Travis CI (macOS) | Code Coverage Status |
|--------------------------|-------------------|-------------------|----------------------|
2017-09-07 17:34:40 +00:00
| [![av-nightly-image][]][av-nightly-site] | [![linux-nightly-image][]][tv-site] | [![macOS-nightly-image][]][tv-site] | [![cc-image][]][cc-site] |
2016-10-12 20:34:24 +00:00
2017-11-06 18:29:49 +00:00
[bd-linux]: https://github.com/PowerShell/PowerShell/tree/master/docs/building/linux.md
[bd-windows]: https://github.com/PowerShell/PowerShell/tree/master/docs/building/windows-core.md
[bd-macOS]: https://github.com/PowerShell/PowerShell/tree/master/docs/building/macos.md
2016-01-21 20:25:48 +00:00
2017-11-06 18:29:49 +00:00
[FAQ]: https://github.com/PowerShell/PowerShell/tree/master/docs/FAQ.md
2016-07-28 19:45:31 +00:00
2016-08-18 15:24:26 +00:00
[tv-image]: https://travis-ci.org/PowerShell/PowerShell.svg?branch=master
[tv-site]: https://travis-ci.org/PowerShell/PowerShell/branches
2016-08-18 15:26:11 +00:00
[av-image]: https://ci.appveyor.com/api/projects/status/nsng9iobwa895f98/branch/master?svg=true
2016-08-18 15:24:26 +00:00
[av-site]: https://ci.appveyor.com/project/PowerShell/powershell
2017-09-05 18:11:47 +00:00
[linux-nightly-image]: https://jimtru1979.blob.core.windows.net/badges/DailyBuildStatus.Linux.svg
2017-09-07 17:34:40 +00:00
[macOS-nightly-image]: https://jimtru1979.blob.core.windows.net/badges/DailyBuildStatus.OSX.svg
2016-10-12 20:34:24 +00:00
[av-nightly-image]: https://ci.appveyor.com/api/projects/status/46yd4jogtm2jodcq?svg=true
[av-nightly-site]: https://ci.appveyor.com/project/PowerShell/powershell-f975h
2017-07-07 16:29:23 +00:00
[cc-site]: https://codecov.io/gh/PowerShell/PowerShell
[cc-image]: https://codecov.io/gh/PowerShell/PowerShell/branch/master/graph/badge.svg
2016-07-28 19:45:31 +00:00
2017-03-21 22:20:11 +00:00
## Downloading the Source Code
2016-07-27 21:47:03 +00:00
2016-07-21 00:09:41 +00:00
The PowerShell repository has a number of other repositories embedded as submodules.
2016-07-27 21:47:03 +00:00
2016-08-11 05:52:53 +00:00
To make things easy, you can just clone recursively:
2016-07-21 00:09:41 +00:00
```sh
git clone --recursive https://github.com/PowerShell/PowerShell.git
```
2016-07-21 00:23:06 +00:00
If you already cloned but forgot to use `--recursive` , you can update submodules manually:
2016-07-27 21:47:03 +00:00
2016-07-21 00:23:06 +00:00
```sh
2016-07-27 21:47:03 +00:00
git submodule update --init
2016-07-21 00:23:06 +00:00
```
2016-07-27 21:47:03 +00:00
2017-11-06 18:29:49 +00:00
See [working with the PowerShell repository ](https://github.com/PowerShell/PowerShell/tree/master/docs/git ) for more information.
2016-07-27 21:47:03 +00:00
2017-03-21 22:20:11 +00:00
## Developing and Contributing
2016-07-20 18:18:28 +00:00
2016-07-27 21:47:03 +00:00
Please see the [Contribution Guide][] for how to develop and contribute.
2016-04-12 23:16:17 +00:00
2016-07-27 21:47:03 +00:00
If you have any problems, please consult the [known issues][], developer [FAQ][], and [GitHub issues][].
If you do not see your problem captured, please file a [new issue][] and follow the provided template.
2016-08-26 19:08:50 +00:00
If you are developing .NET Core C# applications targeting PowerShell Core, please [check out our FAQ][] to learn more about the PowerShell SDK NuGet package.
2016-06-23 15:21:07 +00:00
2016-10-06 18:26:13 +00:00
Also make sure to check out our [PowerShell-RFC repository ](https://github.com/powershell/powershell-rfc ) for request-for-comments (RFC) documents to submit and give comments on proposed and future designs.
2017-11-06 18:29:49 +00:00
[check out our FAQ]: https://github.com/PowerShell/PowerShell/tree/master/docs/FAQ.md#where-do-i-get-the-powershell-core-sdk-package
[Contribution Guide]: https://github.com/PowerShell/PowerShell/tree/master/.github/CONTRIBUTING.md
[known issues]: https://github.com/PowerShell/PowerShell/tree/master/docs/KNOWNISSUES.md
2016-07-27 21:47:03 +00:00
[GitHub issues]: https://github.com/PowerShell/PowerShell/issues
[new issue]:https://github.com/PowerShell/PowerShell/issues/new
2016-06-24 17:47:46 +00:00
2017-03-21 22:20:11 +00:00
## Legal and Licensing
2016-07-29 21:10:26 +00:00
PowerShell is licensed under the [MIT license][].
2017-11-06 18:29:49 +00:00
[MIT license]: https://github.com/PowerShell/PowerShell/tree/master/LICENSE.txt
2016-07-29 21:10:26 +00:00
2017-03-31 19:34:01 +00:00
### Windows Docker Files and Images
License: By requesting and using the Container OS Image for Windows containers, you acknowledge, understand, and consent to the Supplemental License Terms available on Docker hub:
- [Window Server Core ](https://hub.docker.com/r/microsoft/windowsservercore/ )
- [Nano Server ](https://hub.docker.com/r/microsoft/nanoserver/ )
2017-05-03 01:27:42 +00:00
### Telemetry
By default, PowerShell collects the OS description and the version of PowerShell (equivalent to `$PSVersionTable.OS` and `$PSVersionTable.GitCommitId` ) using [Application Insights ](https://azure.microsoft.com/en-us/services/application-insights/ ).
2018-04-13 17:29:39 +00:00
To opt-out of sending telemetry, create an environment variable called `POWERSHELL_TELEMETRY_OPTOUT` set to a value of `1` before starting PowerShell from the installed location.
2017-05-11 17:32:10 +00:00
The telemetry we collect fall under the [Microsoft Privacy Statement ](https://privacy.microsoft.com/en-us/privacystatement/ ).
2017-05-03 01:27:42 +00:00
2017-03-21 22:20:11 +00:00
## Governance
2016-08-12 20:27:04 +00:00
2017-03-27 23:44:28 +00:00
Governance policy for PowerShell project is described [here][].
2016-08-12 20:27:04 +00:00
[here]: https://github.com/PowerShell/PowerShell/blob/master/docs/community/governance.md
2017-06-28 17:34:09 +00:00
## [Code of Conduct][conduct-md]
2016-06-24 17:47:46 +00:00
2016-07-21 00:09:41 +00:00
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
2016-07-27 21:47:03 +00:00
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments.
2016-06-24 17:47:46 +00:00
[conduct-code]: http://opensource.microsoft.com/codeofconduct/
2016-07-19 22:18:55 +00:00
[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/
2016-07-27 21:47:03 +00:00
[conduct-email]: mailto:opencode@microsoft.com
2017-11-06 18:29:49 +00:00
[conduct-md]: https://github.com/PowerShell/PowerShell/tree/master/./CODE_OF_CONDUCT.md
