Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iricigor/installmodulefromgit
Helps installing modules directly from GitHub or Azure DevOps
https://github.com/iricigor/installmodulefromgit
ado azure devops git git-client git-clone github install-module powershell powershell-core powershell-module powershellget vsts windows-powershell
Last synced: 27 days ago
JSON representation
Helps installing modules directly from GitHub or Azure DevOps
- Host: GitHub
- URL: https://github.com/iricigor/installmodulefromgit
- Owner: iricigor
- License: mit
- Created: 2019-03-29T20:04:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-22T04:33:34.000Z (almost 2 years ago)
- Last Synced: 2024-09-28T04:21:10.903Z (about 1 month ago)
- Topics: ado, azure, devops, git, git-client, git-clone, github, install-module, powershell, powershell-core, powershell-module, powershellget, vsts, windows-powershell
- Language: PowerShell
- Size: 206 KB
- Stars: 17
- Watchers: 2
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE
Awesome Lists containing this project
README
   
# Install Module from Git
:bowtie: This PowerShell module will help you to easily instal PowerShell modules directly from [Azure DevOps](https://azure.microsoft.com/en-us/services/devops/repos/) (_aka VSTS_) or [GitHub](https://github.com/) or any other git repository.
All you need to know is a URL of the git repository and the module will take care of everything else.
The module is compatible both with **Linux** and **Windows** versions of PowerShell _(Windows PowerShell 5 or PowerShell Core 6)_.
## Prerequisites
:exclamation: **Git** client must be installed and available on path.
If you don't have it, you can get it for example from [git-scm.com](https://git-scm.com/downloads).
You can check if you have it by running `Get-Command git` in your PowerShell.
## Installation
### From PowerShell gallery
This is recommended way how to install module. [](https://www.powershellgallery.com/packages/InstallModuleFromGit)
```PowerShell
Install-Module InstallModuleFromGit -Scope CurrentUser
```
### Clone GitHub repository
```PowerShell
git clone https://github.com/iricigor/InstallModuleFromGit
Import-Module ./InstallModuleFromGit/InstallModuleFromGit.psd1
```
### Using this module
If you have this module already installed, you can install latest / not-yet-published version from this GitHUb repository using the module itself!
As all commits are verified before and after they are merged to master branch, this should be pretty safe operation also.
```PowerShell
Install-GitModule https://github.com/iricigor/InstallModuleFromGit
```
## Examples
```PowerShell
# Check for module existence and its version
PS:\> Get-GitModule 'https://github.com/iricigor/FIFA2018' -Verbose
# Download and import module in one line
PS:\> (Install-GitModule 'https://github.com/iricigor/psaptgetupdate').Name | Import-Module
```
## Commands
### Module
The module Install Module From Git exposes two new commandlets. More info on module [here](/Docs/InstallModuleFromGit.md).
### Get-GitModule
Checks for module existence and returns its version. More info [here](/Docs/Get-GitModule.md).
### Install-GitModule
Installs PowerShell module to user's default install folder. More info [here](/Docs/Install-GitModule.md).
### Update-GitModule
Updates previously installed PowerShell module if Git repository contains newer version. More info [here](/Docs/Update-GitModule.md).
### Commands Help System
Module provides updatable help system, though it is working currently only on Windows PowerShell. Tracking issue is [here](https://github.com/iricigor/InstallModuleFromGit/issues/3).
```PowerShell
Update-Help -Module InstallModuleFromGit -Force
```
## Tests
:smirk: Module has testing against two platforms - Linux and Windows. Code is verified before and after merging to master branch. Tests results are available on the Tests tab ([example here](/img/TestResults-AzureDevops.png)).
 [](https://dev.azure.com/iiric/PS1/_build/latest?definitionId=16&branchName=master) [](https://dev.azure.com/iiric/PS1/_build/latest?definitionId=17&branchName=master)
_Click on images to see details about the latest build runs._
## Similar PowerShell modules
- :mega: [dfinke](https://github.com/dfinke)/[InstallModuleFromGitHub](https://github.com/dfinke/InstallModuleFromGitHub), (pluses) does not require git client, (minuses) works only with GitHub
## Support
You can chat about this commandlet via [Skype](https://www.skype.com) _(no Skype ID required)_, by clicking a link below.
[](https://join.skype.com/hQMRyp7kwjd2)
## Contributing
If you find any problems, feel free to open a new issue.
[](https://github.com/iricigor/InstallModuleFromGit/issues/new)
If you want to contribute, please fork the code and make a new PR after!
