@@ -8,7 +8,8 @@ schema: 2.0.0
88# Install-GitModule
99
1010## SYNOPSIS
11- {{Fill in the Synopsis}}
11+
12+ This cmdlet installs PowerShell module specified by its git repository URL to user's default install directory.
1213
1314## SYNTAX
1415
@@ -18,21 +19,37 @@ Install-GitModule [-ProjectUri] <String[]> [[-Branch] <String>] [[-DestinationPa
1819```
1920
2021## DESCRIPTION
21- {{Fill in the Description}}
22+
23+ This cmdlet installs PowerShell module specified by its git repository URL to user's default install folder.
24+
25+ You can also specify desired git branch.
26+
27+ Cmdlet internally uses ` Get-GitModule ` cmdlet, so it requires ` git ` client tool to work.
28+ Cmdlet will actually download specified repository to user's default install directory for PowerShell modules.
29+
30+ It does not support functionality ` -Scope AllUsers ` , but it is possible to specify ` -DestinationPath ` argument which will provide the same result.
31+
32+ Cmdlet searches for module manifest (* .psd1) file only. Modules with only * .psm1 files are not supported at the moment.
33+
34+ Note that this will not import module, only install it (the same as built-in cmdlet ` Install-Module ` ).
35+ You can rely on PowerShell's automatic import of modules into user session when needed.
2236
2337## EXAMPLES
2438
2539### Example 1
40+
2641``` powershell
27- PS C:\> {{ Add example code here }}
42+ PS C:\> Install-GitModule 'https://github.com/iricigor/psaptgetupdate' -Verbose
2843```
2944
30- {{ Add example description here }}
45+ This cmdlet will install PowerShell module from [ given repository ] ( https://github.com/iricigor/psaptgetupdate' ) .
3146
3247## PARAMETERS
3348
3449### -Branch
35- {{Fill Branch Description}}
50+
51+ Optional parameter that specifies which branch should be cloned.
52+ If omitted, ` master ` branch will be used.
3653
3754``` yaml
3855Type : String
@@ -47,7 +64,9 @@ Accept wildcard characters: False
4764` ` `
4865
4966### -DestinationPath
50- {{Fill DestinationPath Description}}
67+
68+ If you have a specific setup, you can override default install location with this parameter.
69+ As cmdlet always installs to user specific location, this can be useful to perform system wide installation (requires also elevated prompt).
5170
5271` ` ` yaml
5372Type : String
@@ -62,7 +81,9 @@ Accept wildcard characters: False
6281` ` `
6382
6483### -Force
65- {{Fill Force Description}}
84+
85+ If the module with specified name and the version exists, installation will fail.
86+ You can override this behaviour with ` -Force` switch.
6687
6788` ` ` yaml
6889Type: SwitchParameter
@@ -77,7 +98,13 @@ Accept wildcard characters: False
7798` ` `
7899
79100# ## -ProjectUri
80- {{Fill ProjectUri Description}}
101+
102+ Mandatory parameter specifying URL or the repository. Multiple values are supported.
103+ Parameter is passed to `git` client, so whatever works there is good value.
104+ For example, in GitHub URLs you can specify parameter both with or without `.git` at the end of URL.
105+
106+ You can pass this parameter also via pipeline, for example via `Find-Module` built-in cmdlet.
107+
81108
82109` ` ` yaml
83110Type: String[]
0 commit comments