├── .gitattributes ├── .gitignore ├── InstallModule.ps1 ├── InstallModuleFromGitHub.psd1 ├── InstallModuleFromGitHub.psm1 ├── LICENSE.txt ├── PublishToGallery.ps1 ├── README.md └── media └── InstallFromGitHub.gif /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | 7 | # Standard to msysgit 8 | *.doc diff=astextplain 9 | *.DOC diff=astextplain 10 | *.docx diff=astextplain 11 | *.DOCX diff=astextplain 12 | *.dot diff=astextplain 13 | *.DOT diff=astextplain 14 | *.pdf diff=astextplain 15 | *.PDF diff=astextplain 16 | *.rtf diff=astextplain 17 | *.RTF diff=astextplain 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Windows image file caches 2 | Thumbs.db 3 | ehthumbs.db 4 | 5 | # Folder config file 6 | Desktop.ini 7 | 8 | # Recycle Bin used on file shares 9 | $RECYCLE.BIN/ 10 | 11 | # Windows Installer files 12 | *.cab 13 | *.msi 14 | *.msm 15 | *.msp 16 | 17 | # Windows shortcuts 18 | *.lnk 19 | 20 | # ========================= 21 | # Operating System Files 22 | # ========================= 23 | 24 | # OSX 25 | # ========================= 26 | 27 | .DS_Store 28 | .AppleDouble 29 | .LSOverride 30 | 31 | # Thumbnails 32 | ._* 33 | 34 | # Files that might appear in the root of a volume 35 | .DocumentRevisions-V100 36 | .fseventsd 37 | .Spotlight-V100 38 | .TemporaryItems 39 | .Trashes 40 | .VolumeIcon.icns 41 | 42 | # Directories potentially created on remote AFP share 43 | .AppleDB 44 | .AppleDesktop 45 | Network Trash Folder 46 | Temporary Items 47 | .apdisk 48 | -------------------------------------------------------------------------------- /InstallModule.ps1: -------------------------------------------------------------------------------- 1 | param ($fullPath) 2 | 3 | if (-not $fullPath) { 4 | $fullpath = $env:PSModulePath -split ":(?!\\)|;|," | 5 | Where-Object { $_ -notlike ([System.Environment]::GetFolderPath("UserProfile") + "*") -and $_ -notlike "$pshome*" } | 6 | Select-Object -First 1 7 | $fullPath = Join-Path $fullPath -ChildPath "InstallModuleFromGitHub" 8 | } 9 | 10 | Push-location $PSScriptRoot 11 | Robocopy . $fullPath /mir /XD .vscode .git CI __tests__ data mdHelp /XF appveyor.yml azure-pipelines.yml .gitattributes .gitignore filelist.txt install.ps1 InstallModule.ps1 12 | Pop-Location -------------------------------------------------------------------------------- /InstallModuleFromGitHub.psd1: -------------------------------------------------------------------------------- 1 | @{ 2 | 3 | # Script module or binary module file associated with this manifest. 4 | RootModule = 'InstallModuleFromGitHub.psm1' 5 | 6 | # Version number of this module. 7 | ModuleVersion = '1.7.0' 8 | 9 | # ID used to uniquely identify this module 10 | GUID = '2997e240-5cec-4543-a231-573576b78c88' 11 | 12 | # Author of this module 13 | Author = 'Douglas Finke' 14 | 15 | # Company or vendor of this module 16 | CompanyName = 'Doug Finke' 17 | 18 | # Copyright statement for this module 19 | Copyright = 'c 2021 All rights reserved.' 20 | 21 | # Description of the functionality provided by this module 22 | Description = 'PowerShell module that installs modules from GitHub' 23 | 24 | # Minimum version of the Windows PowerShell engine required by this module 25 | # PowerShellVersion = '' 26 | 27 | # Name of the Windows PowerShell host required by this module 28 | # PowerShellHostName = '' 29 | 30 | # Minimum version of the Windows PowerShell host required by this module 31 | # PowerShellHostVersion = '' 32 | 33 | # Minimum version of Microsoft .NET Framework required by this module 34 | # DotNetFrameworkVersion = '' 35 | 36 | # Minimum version of the common language runtime (CLR) required by this module 37 | # CLRVersion = '' 38 | 39 | # Processor architecture (None, X86, Amd64) required by this module 40 | # ProcessorArchitecture = '' 41 | 42 | # Modules that must be imported into the global environment prior to importing this module 43 | # RequiredModules = @() 44 | 45 | # Assemblies that must be loaded prior to importing this module 46 | # RequiredAssemblies = @() 47 | 48 | # Script files (.ps1) that are run in the caller's environment prior to importing this module. 49 | # ScriptsToProcess = @() 50 | 51 | # Type files (.ps1xml) to be loaded when importing this module 52 | # TypesToProcess = @() 53 | 54 | # Format files (.ps1xml) to be loaded when importing this module 55 | # FormatsToProcess = @() 56 | 57 | # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess 58 | # NestedModules = @() 59 | 60 | # Functions to export from this module 61 | FunctionsToExport = '*' 62 | 63 | # Cmdlets to export from this module 64 | CmdletsToExport = '*' 65 | 66 | # Variables to export from this module 67 | VariablesToExport = '*' 68 | 69 | # Aliases to export from this module 70 | AliasesToExport = '*' 71 | 72 | # List of all modules packaged with this module 73 | # ModuleList = @() 74 | 75 | # List of all files packaged with this module 76 | # FileList = @() 77 | 78 | # Private data to pass to the module specified in RootModule/ModuleToProcess 79 | PrivateData = @{ 80 | # PSData is module packaging and gallery metadata embedded in PrivateData 81 | # It's for rebuilding PowerShellGet (and PoshCode) NuGet-style packages 82 | # We had to do this because it's the only place we're allowed to extend the manifest 83 | # https://connect.microsoft.com/PowerShell/feedback/details/421837 84 | PSData = @{ 85 | # The primary categorization of this module (from the TechNet Gallery tech tree). 86 | Category = "Scripting installation of modules from GitHub" 87 | 88 | # Keyword tags to help users find this module via navigations and search. 89 | Tags = @("GitHub", "Install", "PowerShell", "Module") 90 | 91 | # The web address of an icon which can be used in galleries to represent this module 92 | #IconUri = "http://pesterbdd.com/images/Pester.png" 93 | 94 | # The web address of this module's project or support homepage. 95 | ProjectUri = "https://github.com/dfinke/InstallModuleFromGitHub" 96 | 97 | # The web address of this module's license. Points to a page that's embeddable and linkable. 98 | LicenseUri = "https://github.com/dfinke/InstallModuleFromGitHub/blob/master/LICENSE.txt" 99 | 100 | # Release notes for this particular version of the module 101 | #ReleaseNotes = $True 102 | 103 | # If true, the LicenseUrl points to an end-user license (not just a source license) which requires the user agreement before use. 104 | # RequireLicenseAcceptance = "" 105 | 106 | # Indicates this is a pre-release/testing version of the module. 107 | IsPrerelease = 'False' 108 | } 109 | } 110 | 111 | # HelpInfo URI of this module 112 | # HelpInfoURI = '' 113 | 114 | # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. 115 | # DefaultCommandPrefix = '' 116 | 117 | } -------------------------------------------------------------------------------- /InstallModuleFromGitHub.psm1: -------------------------------------------------------------------------------- 1 | function Install-ModuleFromGitHub { 2 | [CmdletBinding()] 3 | param( 4 | $GitHubRepo, 5 | $Branch = "master", 6 | [Parameter(ValueFromPipelineByPropertyName)] 7 | $ProjectUri, 8 | $DestinationPath, 9 | $SSOToken, 10 | $moduleName, 11 | [ValidateSet('CurrentUser','AllUsers')] 12 | [string] 13 | $Scope 14 | ) 15 | 16 | Process { 17 | if($PSBoundParameters.ContainsKey("ProjectUri")) { 18 | $GitHubRepo = $null 19 | if($ProjectUri.OriginalString.StartsWith("https://github.com")) { 20 | $GitHubRepo = $ProjectUri.AbsolutePath 21 | } else { 22 | $name=$ProjectUri.LocalPath.split('/')[-1] 23 | Write-Host -ForegroundColor Red ("Module [{0}]: not installed, it is not hosted on GitHub " -f $name) 24 | } 25 | } 26 | 27 | if($GitHubRepo) { 28 | Write-Verbose ("[$(Get-Date)] Retrieving {0} {1}" -f $GitHubRepo, $Branch) 29 | 30 | $url = "https://api.github.com/repos/{0}/zipball/{1}" -f $GitHubRepo, $Branch 31 | 32 | if ($moduleName) { 33 | $targetModuleName = $moduleName 34 | } else { 35 | $targetModuleName=$GitHubRepo.split('/')[-1] 36 | } 37 | Write-Debug "targetModuleName: $targetModuleName" 38 | 39 | $tmpDir = [System.IO.Path]::GetTempPath() 40 | 41 | $OutFile = Join-Path -Path $tmpDir -ChildPath "$($targetModuleName).zip" 42 | Write-Debug "OutFile: $OutFile" 43 | 44 | if ($SSOToken) {$headers = @{"Authorization" = "token $SSOToken" }} 45 | 46 | #enable TLS1.2 encryption 47 | if (-not ($IsLinux -or $IsMacOS)) { 48 | [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 49 | } 50 | Invoke-RestMethod $url -OutFile $OutFile -Headers $headers 51 | if (-not ([System.Environment]::OSVersion.Platform -eq "Unix")) { 52 | Unblock-File $OutFile 53 | } 54 | 55 | $fileHash = $(Get-FileHash -Path $OutFile).hash 56 | $tmpDir = "$tmpDir/$fileHash" 57 | 58 | Expand-Archive -Path $OutFile -DestinationPath $tmpDir -Force 59 | 60 | $unzippedArchive = get-childItem "$tmpDir" 61 | Write-Debug "targetModule: $targetModule" 62 | 63 | if ([System.Environment]::OSVersion.Platform -eq "Unix") { 64 | if ($Scope -eq "CurrentUser") { 65 | $dest = Join-Path -Path $HOME -ChildPath ".local/share/powershell/Modules" 66 | } else { 67 | $dest = "/usr/local/share/powershell/Modules" 68 | } 69 | } 70 | 71 | else { 72 | if ($Scope -eq "CurrentUser") { 73 | $scopedPath = $HOME 74 | $scopedChildPath = "\Documents\PowerShell\Modules" 75 | } else { 76 | $scopedPath = $env:ProgramFiles 77 | $scopedChildPath = "\PowerShell\Modules" 78 | } 79 | $dest = Join-Path -Path $scopedPath -ChildPath $scopedChildPath 80 | } 81 | 82 | if($DestinationPath) { 83 | $dest = $DestinationPath 84 | } 85 | $dest = Join-Path -Path $dest -ChildPath $targetModuleName 86 | if ([System.Environment]::OSVersion.Platform -eq "Unix") { 87 | $psd1 = Get-ChildItem (Join-Path -Path $unzippedArchive -ChildPath *) -Include *.psd1 -Recurse 88 | } else { 89 | $psd1 = Get-ChildItem (Join-Path -Path $tmpDir -ChildPath $unzippedArchive.Name) -Include *.psd1 -Recurse 90 | } 91 | 92 | $sourcePath = $unzippedArchive.FullName 93 | 94 | if($psd1) { 95 | $ModuleVersion=(Get-Content -Raw $psd1.FullName | Invoke-Expression).ModuleVersion 96 | $dest = Join-Path -Path $dest -ChildPath $ModuleVersion 97 | $null = New-Item -ItemType directory -Path $dest -Force 98 | $sourcePath = $psd1.DirectoryName 99 | } 100 | 101 | 102 | 103 | if ([System.Environment]::OSVersion.Platform -eq "Unix") { 104 | $null = Copy-Item "$(Join-Path -Path $unzippedArchive -ChildPath *)" $dest -Force -Recurse 105 | } else { 106 | $null = Copy-Item "$sourcePath\*" $dest -Force -Recurse 107 | } 108 | } 109 | } 110 | } 111 | 112 | # Install-ModuleFromGitHub dfinke/nameit 113 | # Install-ModuleFromGitHub dfinke/nameit TestBranch 114 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2016 Doug Finke 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /PublishToGallery.ps1: -------------------------------------------------------------------------------- 1 | $p = @{ 2 | Name = "InstallModuleFromGitHub" 3 | NuGetApiKey = $NuGetApiKey 4 | ReleaseNote = "First Release" 5 | } 6 | 7 | Publish-Module @p -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Install a PowerShell Module from GitHub 2 | - 3 | 4 | Not all PowerShell Modules are published to the PowerShellGallery but are hosted on GitHub. 5 | 6 | [Read the blog post](https://dfinke.github.io/powershell/2016/11/21/Quickly-Install-PowerShell-Modules-from-GitHub.html) 7 | 8 | ## Changes 9 | 10 | ## 1.6.0 11 | 12 | via https://github.com/dfinke/InstallModuleFromGitHub/pull/25 13 | 14 | - on non-unix platforms, fixed the psd1 file search 15 | join-path on line 87 was joining two full paths, which is not a 16 | valid result. 17 | ## 1.5.0 18 | 19 | Thank you to [Max Renner](https://github.com/rennerom) for the pull request. 20 | 21 | - Use [System.Environment]::OSVersion.Platform -eq "Unix" as a catch all for non-windows systems 22 | - Replaced the hard coded Module paths assigned to $dest with environment variables instead. 23 | - Added if logic for Windows vs Non-Windows machines in assigning $psd1 and in the final Copy-Item statement. 24 | 25 | ## 1.4.0 26 | 27 | - Fix module installation path (Thanks [JonathanPitre](https://github.com/JonathanPitre)) 28 | 29 | ## v 0.5.0 30 | 31 | - Allow for copying folders recursively. Thank you to: 32 | - https://github.com/montereyharris 33 | - https://github.com/jayvdb 34 | - https://github.com/JonathanPitre 35 | 36 | ## In Action 37 | ![image](https://github.com/dfinke/InstallModuleFromGitHub/blob/master/media/InstallFromGitHub.gif?raw=true) -------------------------------------------------------------------------------- /media/InstallFromGitHub.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dfinke/InstallModuleFromGitHub/0af91fe6e9360aa7be0b9bd2dc7f92b93ef9e8ed/media/InstallFromGitHub.gif --------------------------------------------------------------------------------