2017-03-21 23:20:11 +01:00
# ![logo][] PowerShell
2015-07-02 00:06:29 +02:00
2016-08-18 17:55:00 +02:00
Welcome to the PowerShell GitHub Community!
2017-03-28 01:44:28 +02:00
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.
2016-07-27 23:47:03 +02:00
[logo]: assets/Powershell_64.png
2016-03-31 00:13:29 +02:00
2017-03-21 23:20:11 +01:00
## New to PowerShell?
2016-03-31 00:13:29 +02:00
2016-07-27 23:47:03 +02:00
If you are new to PowerShell and would like to learn more, we recommend reviewing the [getting started][] documentation.
2016-01-22 20:36:23 +01:00
2016-07-27 23:47:03 +02:00
[getting started]: docs/learning-powershell
2016-03-30 21:06:57 +02:00
2017-03-21 23:20:11 +01:00
## Get PowerShell
2016-03-31 00:13:29 +02:00
2016-07-27 23:47:03 +02:00
You can download and install a PowerShell package for any of the following platforms.
2016-11-23 02:50:45 +01:00
| Platform | Downloads | How to Install |
| ---------------------------------- | ---------------------- | ----------------------------- |
| Windows 10 / Server 2016 (x64) | [.msi][rl-windows10] | [Instructions][in-windows] |
| Windows 8.1 / Server 2012 R2 (x64) | [.msi][rl-windows81] | [Instructions][in-windows] |
| Windows 7 (x64) | [.msi][rl-windows7-64] | [Instructions][in-windows] |
| Windows 7 (x86) | [.msi][rl-windows7-86] | [Instructions][in-windows] |
| Ubuntu 16.04 | [.deb][rl-ubuntu16] | [Instructions][in-ubuntu16] |
| Ubuntu 14.04 | [.deb][rl-ubuntu14] | [Instructions][in-ubuntu14] |
2017-05-09 22:18:01 +02:00
| Debian 8 | [.deb][rl-ubuntu14] | [Instructions][in-deb8] |
2016-11-23 02:50:45 +01:00
| CentOS 7 | [.rpm][rl-centos] | [Instructions][in-centos] |
2017-05-09 22:18:01 +02:00
| Red Hat Enterprise Linux 7 | [.rpm][rl-centos] | [Instructions][in-rhel7] |
2017-04-05 02:41:40 +02:00
| OpenSUSE 42.1 | [.rpm][rl-opensuse421] | [Instructions][in-opensuse421]|
2017-03-02 02:38:24 +01:00
| Arch Linux | | [Instructions][in-archlinux] |
2016-08-23 02:37:43 +02:00
| Many Linux distributions | [.AppImage][rl-ai] | [Instructions][in-appimage] |
2017-05-10 18:49:02 +02:00
| macOS 10.12 | [.pkg][rl-macos] | [Instructions][in-macos] |
2016-11-23 02:50:45 +01:00
| Docker | | [Instructions][in-docker] |
2017-05-10 18:49:02 +02:00
[rl-windows10]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-beta.1/PowerShell-6.0.0-beta.1-win10-win2016-x64.msi
[rl-windows81]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-beta.1/PowerShell-6.0.0-beta.1-win81-win2012r2-x64.msi
2017-04-07 21:03:29 +02:00
[rl-windows7-64]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.18/PowerShell-6.0.0-alpha.18-win7-win2008r2-x64.msi
[rl-windows7-86]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.18/PowerShell-6.0.0-alpha.18-win7-x86.msi
2017-05-10 18:49:02 +02:00
[rl-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-beta.1/powershell_6.0.0-beta.1-1ubuntu1.16.04.1_amd64.deb
[rl-ubuntu14]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-beta.1/powershell_6.0.0-beta.1-1ubuntu1.14.04.1_amd64.deb
[rl-centos]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-beta.1/powershell-6.0.0_beta.1-1.el7.centos.x86_64.rpm
[rl-ai]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-beta.1/PowerShell-6.0.0-beta.1-x86_64.AppImage
[rl-macos]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-beta.1/powershell-6.0.0-beta.1-osx.10.12-x64.pkg
[rl-opensuse421]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-beta.1/powershell-6.0.0_beta.1-1.suse.42.1.x86_64.rpm
2016-07-27 23:47:03 +02:00
[installation]: docs/installation
[in-windows]: docs/installation/windows.md#msi
2016-08-12 01:55:04 +02:00
[in-ubuntu14]: docs/installation/linux.md#ubuntu-1404
[in-ubuntu16]: docs/installation/linux.md#ubuntu-1604
2017-05-09 22:18:01 +02:00
[in-deb8]: docs/installation/linux.md#debian-8
2016-07-27 23:47:03 +02:00
[in-centos]: docs/installation/linux.md#centos-7
2017-05-09 22:18:01 +02:00
[in-rhel7]: docs/installation/linux.md#red-hat-enterprise-linux-rhel-7
2017-03-02 02:38:24 +01:00
[in-archlinux]: docs/installation/linux.md#arch-linux
2016-08-23 02:37:43 +02:00
[in-appimage]: docs/installation/linux.md#linux-appimage
2017-05-10 18:49:02 +02:00
[in-macos]: docs/installation/linux.md#macos-1012
2016-09-12 23:55:46 +02:00
[in-docker]: docker
2017-04-05 02:41:40 +02:00
[in-opensuse421]: docs/installation/linux.md#opensuse-421
2016-06-24 20:18:01 +02:00
2016-08-05 23:10:42 +02:00
To install a specific version, visit [releases ](https://github.com/PowerShell/PowerShell/releases ).
2016-07-14 00:59:08 +02:00
2017-03-21 23:20:11 +01:00
## Community Dashboard
2017-03-07 02:28:42 +01: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 23:20:11 +01:00
## Chat Room
2016-08-18 17:44:07 +02:00
Want to chat with other members of the PowerShell community?
2016-08-30 04:30:23 +02:00
We have a Gitter Room which you can join below.
2016-08-18 17:44:07 +02:00
[![Join the chat at https://gitter.im/PowerShell/PowerShell ](https://badges.gitter.im/PowerShell/PowerShell.svg )](https://gitter.im/PowerShell/PowerShell?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2017-03-21 23:20:11 +01:00
There is also the community driven PowerShell Slack Team which you can sign up for at [Slack Sign up].
2016-08-30 04:30:23 +02:00
2017-03-21 23:20:11 +01:00
[Slack Sign up]: http://slack.poshcode.org
## Building the Repository
2016-07-27 23:47:03 +02:00
2016-08-26 21:08:50 +02:00
| Linux | Windows | macOS |
2016-07-27 23:47:03 +02:00
|--------------------------|----------------------------|------------------------|
2016-08-26 21:08:50 +02:00
| [Instructions][bd-linux] | [Instructions][bd-windows] | [Instructions][bd-macOS] |
2016-07-27 23:47:03 +02:00
2016-07-28 21:45:31 +02:00
If you have any problems building, please consult the developer [FAQ][].
### Build status of master branches
2016-08-26 21:08:50 +02:00
| AppVeyor (Windows) | Travis CI (Linux / macOS) |
2016-07-28 21:45:31 +02:00
|--------------------------|--------------------------|
| [![av-image][]][av-site] | [![tv-image][]][tv-site] |
2016-10-12 22:34:24 +02:00
### Build status of nightly builds
2017-02-02 00:53:30 +01:00
| AppVeyor (Windows) | Travis CI (Linux / macOS) | Code Coverage Status |
|--------------------------|---------------------------|----------------------|
| [![av-nightly-image][]][av-nightly-site] | [![tv-nightly-image][]][tv-site] | [![cc-image][]][cc-site] |
2016-10-12 22:34:24 +02:00
2016-07-27 23:47:03 +02:00
[bd-linux]: docs/building/linux.md
[bd-windows]: docs/building/windows-core.md
2016-08-26 21:08:50 +02:00
[bd-macOS]: docs/building/macos.md
2016-01-21 21:25:48 +01:00
2016-07-28 21:45:31 +02:00
[FAQ]: docs/FAQ.md
2016-08-18 17:24:26 +02:00
[tv-image]: https://travis-ci.org/PowerShell/PowerShell.svg?branch=master
[tv-site]: https://travis-ci.org/PowerShell/PowerShell/branches
2016-08-18 17:26:11 +02:00
[av-image]: https://ci.appveyor.com/api/projects/status/nsng9iobwa895f98/branch/master?svg=true
2016-08-18 17:24:26 +02:00
[av-site]: https://ci.appveyor.com/project/PowerShell/powershell
2017-03-29 07:15:52 +02:00
[tv-nightly-image]: https://jimtru1979.blob.core.windows.net/badges/DailyBuildStatus.svg
2016-10-12 22:34:24 +02: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
2016-12-21 17:42:54 +01:00
[cc-site]: https://coveralls.io/github/PowerShell/PowerShell?branch=master
[cc-image]: https://coveralls.io/repos/github/PowerShell/PowerShell/badge.svg?branch=master
2016-07-28 21:45:31 +02:00
2017-03-21 23:20:11 +01:00
## Downloading the Source Code
2016-07-27 23:47:03 +02:00
2016-07-21 02:09:41 +02:00
The PowerShell repository has a number of other repositories embedded as submodules.
2016-07-27 23:47:03 +02:00
2016-08-11 07:52:53 +02:00
To make things easy, you can just clone recursively:
2016-07-21 02:09:41 +02:00
```sh
git clone --recursive https://github.com/PowerShell/PowerShell.git
```
2016-07-21 02:23:06 +02:00
If you already cloned but forgot to use `--recursive` , you can update submodules manually:
2016-07-27 23:47:03 +02:00
2016-07-21 02:23:06 +02:00
```sh
2016-07-27 23:47:03 +02:00
git submodule update --init
2016-07-21 02:23:06 +02:00
```
2016-07-27 23:47:03 +02:00
2016-07-27 23:51:18 +02:00
See [working with the PowerShell repository ](docs/git ) for more information.
2016-07-27 23:47:03 +02:00
2017-03-21 23:20:11 +01:00
## Developing and Contributing
2016-07-20 20:18:28 +02:00
2016-07-27 23:47:03 +02:00
Please see the [Contribution Guide][] for how to develop and contribute.
2016-04-13 01:16:17 +02:00
2016-07-27 23:47:03 +02: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 21:08:50 +02: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 17:21:07 +02:00
2016-10-06 20:26:13 +02: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.
2016-08-18 22:34:59 +02:00
[check out our FAQ]: docs/FAQ.md#where-do-i-get-the-powershell-core-sdk-package
2016-07-27 23:47:03 +02:00
[Contribution Guide]: .github/CONTRIBUTING.md
[known issues]: docs/KNOWNISSUES.md
[GitHub issues]: https://github.com/PowerShell/PowerShell/issues
[new issue]:https://github.com/PowerShell/PowerShell/issues/new
2016-06-24 19:47:46 +02:00
2017-03-21 23:20:11 +01:00
## Legal and Licensing
2016-07-29 23:10:26 +02:00
PowerShell is licensed under the [MIT license][].
[MIT license]: LICENSE.txt
2017-03-31 21:34:01 +02: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 03:27:42 +02: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/ ).
To opt-out of sending telemetry, delete the file `DELETE_ME_TO_DISABLE_CONSOLEHOST_TELEMETRY` before starting PowerShell from the installed location.
2017-05-11 19:32:10 +02:00
The telemetry we collect fall under the [Microsoft Privacy Statement ](https://privacy.microsoft.com/en-us/privacystatement/ ).
2017-05-03 03:27:42 +02:00
2017-03-21 23:20:11 +01:00
## Governance
2016-08-12 22:27:04 +02:00
2017-03-28 01:44:28 +02:00
Governance policy for PowerShell project is described [here][].
2016-08-12 22:27:04 +02:00
[here]: https://github.com/PowerShell/PowerShell/blob/master/docs/community/governance.md
2017-03-21 23:20:11 +01:00
## Code of Conduct
2016-06-24 19:47:46 +02:00
2016-07-21 02:09:41 +02:00
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
2016-07-27 23:47:03 +02: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 19:47:46 +02:00
[conduct-code]: http://opensource.microsoft.com/codeofconduct/
2016-07-20 00:18:55 +02:00
[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/
2016-07-27 23:47:03 +02:00
[conduct-email]: mailto:opencode@microsoft.com