2016-03-30 23:54:49 +02:00
Build PowerShell on Windows for .NET Core
=========================================
2016-08-27 02:28:45 +02:00
This guide will walk you through building PowerShell on Windows, targeting .NET Core.
We'll start by showing how to set up your environment from scratch.
2016-03-30 23:54:49 +02:00
2016-07-25 22:17:51 +02:00
You can also [build PowerShell for Full .NET framework ](windows-full.md ) on Windows.
2016-03-30 23:54:49 +02:00
Environment
===========
These instructions are tested on Windows 10 and Windows Server 2012
R2, though they should work anywhere the dependencies work.
2016-04-14 01:21:23 +02:00
Git Setup
---------
Using Git requires it to be setup correctly; refer to the
[README ](../../README.md ) and
2016-04-22 23:37:26 +02:00
[Contributing Guidelines ](../../.github/CONTRIBUTING.md ).
2016-04-14 01:21:23 +02:00
2016-08-27 02:28:45 +02:00
This guide assumes that you have recursively cloned the PowerShell repository and `cd` ed into it.
2016-04-14 01:21:23 +02:00
2016-08-20 00:43:40 +02:00
Visual Studio
----------------
2016-08-27 02:28:45 +02:00
You will need to install an edition of Visual Studio 2015 (Community, Enterprise, or Professional) with the optional feature 'Common Tools for Visual C++' installed.
The free Community edition of Visual Studio 2015 can be downloaded [here ](https://www.visualstudio.com/visual-studio-community-vs/ ).
2016-08-20 00:43:40 +02:00
2016-03-30 23:54:49 +02:00
.NET CLI
--------
2016-07-22 00:50:04 +02:00
We use the [.NET Command Line Interface][dotnet-cli] (`dotnet`) to build PowerShell.
2017-03-28 00:26:22 +02:00
The version we are currently using is `1.0.1` .
2016-07-22 00:50:04 +02:00
The `Start-PSBootstrap` function will automatically install it and add it to your path:
2016-04-14 01:21:23 +02:00
```powershell
2016-05-18 22:58:59 +02:00
Import-Module ./build.psm1
2016-04-14 01:21:23 +02:00
Start-PSBootstrap
```
2017-03-28 00:26:22 +02:00
The `Start-PSBootstrap` function calls `Install-Dotnet` :
2016-03-30 23:54:49 +02:00
```powershell
2017-03-28 00:26:22 +02:00
Install-Dotnet -Channel rel-1.0.0 -Version 1.0.1
```
It removes the previously installed version of .NET CLI from `$env:LOCALAPPDATA\Microsoft\dotnet` and then does exactly this:
```powershell
Invoke-WebRequest -Uri https://raw.githubusercontent.com/dotnet/cli/v1.0.1/scripts/obtain/dotnet-install.ps1 -OutFile dotnet-install.ps1
./dotnet-install.ps1 -Channel rel-1.0.0 -Version 1.0.1
2016-03-30 23:54:49 +02:00
```
2016-08-27 02:28:45 +02:00
If you have any problems installing `dotnet` , please see their [documentation][cli-docs].
2016-03-30 23:54:49 +02:00
2017-03-28 00:26:22 +02:00
[dotnet-cli]: https://github.com/dotnet/cli
[cli-docs]: https://www.microsoft.com/net/core#windowscmd
2016-03-30 23:54:49 +02:00
Build using our module
======================
2016-08-27 02:28:45 +02:00
We maintain a [PowerShell module ](../../build.psm1 ) with the function `Start-PSBuild` to build PowerShell.
2016-03-30 23:54:49 +02:00
```powershell
2016-05-18 22:58:59 +02:00
Import-Module ./build.psm1
2016-03-30 23:54:49 +02:00
Start-PSBuild
```
2017-03-28 00:26:22 +02:00
Congratulations! If everything went right, PowerShell is now built and executable as `./src/powershell-win-core/bin/Debug/netcoreapp1.1/win10-x64/powershell` .
2016-04-05 04:07:29 +02:00
2016-08-27 02:28:45 +02:00
This location is of the form `./[project]/bin/[configuration]/[framework]/[rid]/[binary name]` ,
and our project is `powershell` , configuration is `Debug` by default,
2016-12-08 03:29:21 +01:00
framework is `netcoreapp1.1` , runtime identifier is **probably** `win10-x64`
2016-08-27 02:28:45 +02:00
(but will depend on your operating system;
don't worry, `dotnet --info` will tell you what it was), and binary name is `powershell` .
The function `Get-PSOutput` will return the path to the executable;
thus you can execute the development copy via `& (Get-PSOutput)` .
2016-04-05 04:07:29 +02:00
2016-08-27 02:28:45 +02:00
The `powershell` project is the .NET Core PowerShell host.
It is the top level project, so `dotnet build` transitively builds all its dependencies,
and emits a `powershell` executable.
The cross-platform host has built-in documentation via `--help` .
2016-04-05 04:07:29 +02:00
You can run our cross-platform Pester tests with `Start-PSPester` .
2016-08-14 22:52:40 +02:00
Building in Visual Studio
2017-03-28 00:26:22 +02:00
-------------------------
2016-08-14 22:52:40 +02:00
2017-03-28 00:26:22 +02:00
We currently have the issue [#3400 ](https://github.com/PowerShell/PowerShell/issues/3400 ) tracking this task.