@@ -8,7 +8,8 @@ schema: 2.0.0
8
8
# Install-GitModule
9
9
10
10
## 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.
12
13
13
14
## SYNTAX
14
15
@@ -18,21 +19,37 @@ Install-GitModule [-ProjectUri] <String[]> [[-Branch] <String>] [[-DestinationPa
18
19
```
19
20
20
21
## 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.
22
36
23
37
## EXAMPLES
24
38
25
39
### Example 1
40
+
26
41
``` powershell
27
- PS C:\> {{ Add example code here }}
42
+ PS C:\> Install-GitModule 'https://github.com/iricigor/psaptgetupdate' -Verbose
28
43
```
29
44
30
- {{ Add example description here }}
45
+ This cmdlet will install PowerShell module from [ given repository ] ( https://github.com/iricigor/psaptgetupdate' ) .
31
46
32
47
## PARAMETERS
33
48
34
49
### -Branch
35
- {{Fill Branch Description}}
50
+
51
+ Optional parameter that specifies which branch should be cloned.
52
+ If omitted, ` master ` branch will be used.
36
53
37
54
``` yaml
38
55
Type : String
@@ -47,7 +64,9 @@ Accept wildcard characters: False
47
64
` ` `
48
65
49
66
### -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).
51
70
52
71
` ` ` yaml
53
72
Type : String
@@ -62,7 +81,9 @@ Accept wildcard characters: False
62
81
` ` `
63
82
64
83
### -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.
66
87
67
88
` ` ` yaml
68
89
Type: SwitchParameter
@@ -77,7 +98,13 @@ Accept wildcard characters: False
77
98
` ` `
78
99
79
100
# ## -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
+
81
108
82
109
` ` ` yaml
83
110
Type: String[]
0 commit comments