2016-07-28 05:47:03 +08:00
![logo][] PowerShell
====================
2015-07-02 06:06:29 +08:00
2016-08-18 23:55:00 +08:00
Welcome to the PowerShell GitHub Community!
2016-08-27 03:08:50 +08: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-08-18 01:29:14 +08:00
2016-07-28 05:47:03 +08:00
[logo]: assets/Powershell_64.png
2016-03-31 06:13:29 +08:00
2016-06-25 02:18:01 +08:00
New to PowerShell?
------------------
2016-03-31 06:13:29 +08:00
2016-07-28 05:47:03 +08:00
If you are new to PowerShell and would like to learn more, we recommend reviewing the [getting started][] documentation.
2016-01-23 03:36:23 +08:00
2016-07-28 05:47:03 +08:00
[getting started]: docs/learning-powershell
2016-03-31 03:06:57 +08:00
2016-03-31 06:13:29 +08:00
Get PowerShell
--------------
2016-07-28 05:47:03 +08:00
You can download and install a PowerShell package for any of the following platforms.
2016-08-20 03:37:28 +08:00
| Platform | Downloads | How to Install |
| ------------------------------ | ---------------------- | ----------------------------- |
| Windows 10 / Server 2016 | [.msi][rl-windows10] | [Instructions][in-windows] |
| Windows 8.1 / Server 2012 R2 | [.msi][rl-windows81] | [Instructions][in-windows] |
| Ubuntu 16.04 | [.deb][rl-ubuntu16] | [Instructions][in-ubuntu16] |
| Ubuntu 14.04 | [.deb][rl-ubuntu14] | [Instructions][in-ubuntu14] |
| CentOS 7 | [.rpm][rl-centos] | [Instructions][in-centos] |
2016-09-13 05:55:46 +08:00
| macOS 10.11 | [.pkg][rl-macos] | [Instructions][in-macos] |
| Docker | | [Instructions][in-docker] |
2016-08-16 10:02:27 +08:00
2016-11-04 05:23:05 +08:00
[rl-windows10]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.12/PowerShell_6.0.0.12-alpha.12-win10-x64.msi
[rl-windows81]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.12/PowerShell_6.0.0.12-alpha.12-win81-x64.msi
[rl-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.12/powershell_6.0.0-alpha.12-1ubuntu1.16.04.1_amd64.deb
[rl-ubuntu14]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.12/powershell_6.0.0-alpha.12-1ubuntu1.14.04.1_amd64.deb
[rl-centos]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.12/powershell-6.0.0_alpha.12-1.el7.centos.x86_64.rpm
[rl-macOS]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.12/powershell-6.0.0-alpha.12.pkg
2016-07-28 05:47:03 +08:00
[installation]: docs/installation
[in-windows]: docs/installation/windows.md#msi
2016-08-12 07:55:04 +08:00
[in-ubuntu14]: docs/installation/linux.md#ubuntu-1404
[in-ubuntu16]: docs/installation/linux.md#ubuntu-1604
2016-07-28 05:47:03 +08:00
[in-centos]: docs/installation/linux.md#centos-7
2016-08-27 03:08:50 +08:00
[in-macos]: docs/installation/linux.md#macos-1011
2016-09-13 05:55:46 +08:00
[in-docker]: docker
2016-06-25 02:18:01 +08:00
2016-08-06 05:10:42 +08:00
To install a specific version, visit [releases ](https://github.com/PowerShell/PowerShell/releases ).
2016-07-14 06:59:08 +08:00
2016-08-18 23:44:07 +08:00
Chat Room
---------
Want to chat with other members of the PowerShell community?
2016-08-30 10:30:23 +08:00
We have a Gitter Room which you can join below.
2016-08-18 23:44:07 +08:00
[](https://gitter.im/PowerShell/PowerShell?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2016-08-30 10:30:23 +08:00
There is also the community driven PowerShell Slack Team which you can sign up for at [Slack Signup].
[Slack Signup]: http://slack.poshcode.org
2016-07-28 05:47:03 +08:00
Building the Repository
-----------------------
2016-08-27 03:08:50 +08:00
| Linux | Windows | macOS |
2016-07-28 05:47:03 +08:00
|--------------------------|----------------------------|------------------------|
2016-08-27 03:08:50 +08:00
| [Instructions][bd-linux] | [Instructions][bd-windows] | [Instructions][bd-macOS] |
2016-07-28 05:47:03 +08:00
2016-07-29 03:45:31 +08:00
If you have any problems building, please consult the developer [FAQ][].
### Build status of master branches
2016-08-27 03:08:50 +08:00
| AppVeyor (Windows) | Travis CI (Linux / macOS) |
2016-07-29 03:45:31 +08:00
|--------------------------|--------------------------|
| [![av-image][]][av-site] | [![tv-image][]][tv-site] |
2016-10-13 04:34:24 +08:00
### Build status of nightly builds
| AppVeyor (Windows) |
|--------------------------|
| [![av-nightly-image][]][av-nightly-site] |
2016-07-28 05:47:03 +08:00
[bd-linux]: docs/building/linux.md
[bd-windows]: docs/building/windows-core.md
2016-08-27 03:08:50 +08:00
[bd-macOS]: docs/building/macos.md
2016-01-22 04:25:48 +08:00
2016-07-29 03:45:31 +08:00
[FAQ]: docs/FAQ.md
2016-08-18 23:24:26 +08:00
[tv-image]: https://travis-ci.org/PowerShell/PowerShell.svg?branch=master
[tv-site]: https://travis-ci.org/PowerShell/PowerShell/branches
2016-08-18 23:26:11 +08:00
[av-image]: https://ci.appveyor.com/api/projects/status/nsng9iobwa895f98/branch/master?svg=true
2016-08-18 23:24:26 +08:00
[av-site]: https://ci.appveyor.com/project/PowerShell/powershell
2016-10-13 04:34:24 +08: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-07-29 03:45:31 +08:00
2016-07-21 08:09:41 +08:00
Downloading the Source Code
2016-07-28 05:47:03 +08:00
---------------------------
2016-07-21 08:09:41 +08:00
The PowerShell repository has a number of other repositories embedded as submodules.
2016-07-28 05:47:03 +08:00
2016-08-11 13:52:53 +08:00
To make things easy, you can just clone recursively:
2016-07-21 08:09:41 +08:00
```sh
git clone --recursive https://github.com/PowerShell/PowerShell.git
```
2016-07-21 08:23:06 +08:00
If you already cloned but forgot to use `--recursive` , you can update submodules manually:
2016-07-28 05:47:03 +08:00
2016-07-21 08:23:06 +08:00
```sh
2016-07-28 05:47:03 +08:00
git submodule update --init
2016-07-21 08:23:06 +08:00
```
2016-07-28 05:47:03 +08:00
2016-07-28 05:51:18 +08:00
See [working with the PowerShell repository ](docs/git ) for more information.
2016-07-28 05:47:03 +08:00
2016-07-20 06:18:10 +08:00
Developing and Contributing
--------------------------
2016-07-21 02:18:28 +08:00
2016-07-28 05:47:03 +08:00
Please see the [Contribution Guide][] for how to develop and contribute.
2016-04-13 07:16:17 +08:00
2016-07-28 05:47:03 +08: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-27 03:08:50 +08: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 23:21:07 +08:00
2016-10-07 02:26:13 +08: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-19 04:34:59 +08:00
[check out our FAQ]: docs/FAQ.md#where-do-i-get-the-powershell-core-sdk-package
2016-07-28 05:47:03 +08: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-25 01:47:46 +08:00
2016-07-30 05:10:26 +08:00
Legal and Licensing
-------------------
PowerShell is licensed under the [MIT license][].
[MIT license]: LICENSE.txt
2016-08-13 04:27:04 +08:00
Governance
-------------------
Governance policy for PowerShell project is described [here][].
[here]: https://github.com/PowerShell/PowerShell/blob/master/docs/community/governance.md
2016-06-25 01:47:46 +08:00
Code of Conduct
---------------
2016-07-21 08:09:41 +08:00
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
2016-07-28 05:47:03 +08: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-25 01:47:46 +08:00
[conduct-code]: http://opensource.microsoft.com/codeofconduct/
2016-07-20 06:18:55 +08:00
[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/
2016-07-28 05:47:03 +08:00
[conduct-email]: mailto:opencode@microsoft.com
