en-US/about_Carbon_Installation.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
TOPIC
    about_Carbon_Installation
    
SHORT DESCRIPTION
    Carbon can be installed from a ZIP archive, from the PowerShell gallery, with 
    Chocolatey, and NuGet.
    
INSTALL FROM ZIP ARCHIVE
    1. [Download the ZIP file from GitHub.](https://github.com/pshdo/Carbon/releases)
    2. Unblock the zip file (right-click the .zip file, choose Properties, click 
       "Unblock", then click "OK").
    3. Unzip the Carbon module anywhere on your file system. 
    
    You can now import module using the `Import-Carbon.ps1` script:
    
        PS> .\Carbon\Import-Carbon.ps1
    
    To make Carbon available so you can run `Import-Module Carbon`, copy the `Carbon`
    directory into one of PowerShell's module paths. This command will you a list: PS> $env:PSModulePath -split ';'
     
    Once you do, you can import Carbon by running:
     
        PS> Import-Module '
Carbon' INSTALL FROM POWERSHELL GALLERY To install from the PowerShell Gallery, you must be running PowerShell 5 or PowerShell 4 with the [Package Management PowerShell Modules Preview](https://www.microsoft.com/en-us/download/details.aspx?id=51451) installed. To install, run: PS> Install-Module -Name 'Carbon' -AllowClobber Note: You need the `-AllowClobber` switch because Windows 10/2016 ships with modules that contain functions with the same name as some of Carbon's
    functions.
    
    You can now import Carbon by running:
    
        PS> Import-Module 'Carbon'
  
INSTALL WITH CHOCOLATEY
    To install with Chocolatey, you'll need [Chocolatey installed](http://chocolatey.org). With Chocolatey installed, run: PS> choco install Carbon This will install Carbon into one of PowerShell's module paths. You can now import
    Carbon by running:
    
        PS> Import-Module 'Carbon'  

INSTALL WITH NUGET
    To install with NuGet, you'll need [NuGet installed](http://nuget.org). With NuGet installed, run: PS> nuget install Carbon This will create a `Carbon-X.Y.Z` directory in your current directory (or the output directory you specified with Nuget's `OutputDirectory` parameter). You can
    import Carbon from that directory using the `Import-Carbon.ps1 script:
    
        PS> .\Carbon-X.Y.Z\Carbon\Import-Carbon.ps1
     
    Or with PowerShell's `Import-Module` command: PS> Import-Module '.\Carbon-X.Y.Z\Carbon' If you want Carbon available so you can run `Import-Module Carbon`, copy the `Carbon-X.Y.Z\Carbon` directory into one of PowerShell's module paths. This command
    will give you a list:
    
        PS> $env:PSModulePath -split ';'

SEE ALSO
    http://chocolatey.org
    http://www.nuget.org
    https://www.powershellgallery.com/
    https://github.com/pshdo/Carbon/releases