Find-WinGetPackage.md (5504B)
1 --- 2 external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml 3 Module Name: Microsoft.WinGet.Client 4 ms.date: 08/01/2024 5 online version: 6 schema: 2.0.0 7 title: Find-WinGetPackage 8 --- 9 10 # Find-WinGetPackage 11 12 ## SYNOPSIS 13 Searches for packages from configured sources. 14 15 ## SYNTAX 16 17 ``` 18 Find-WinGetPackage [-Tag <String>] [-Command <String>] [-Count <UInt32>] [-Id <String>] [-Name <String>] 19 [-Moniker <String>] [-Source <String>] [[-Query] <String[]>] [-MatchOption <PSPackageFieldMatchOption>] 20 [<CommonParameters>] 21 ``` 22 23 ## DESCRIPTION 24 25 Searches for packages from configured sources. 26 27 ## EXAMPLES 28 29 ### Example 1: Search for PowerShell 30 31 ```powershell 32 Find-WinGetPackage PowerShell 33 ``` 34 35 This example shows how to search for packages related to PowerShell. By default, the command 36 searches all configured sources. The command compares the value provided to the following package 37 manifest properties: 38 39 - `PackageIdentifier` 40 - `PackageName` 41 - `Moniker` 42 - `Tags` 43 44 The command does a case-insensitive substring comparison of these properties. 45 46 ### Example 2: Search for Microsoft.PowerShell by id 47 48 ```powershell 49 Find-WinGetPackage -Id Microsoft.PowerShell 50 ``` 51 52 This example shows how to search for packages by package identifier. By default, the command 53 searches all configured sources. The command performs a case-insensitive substring match against the 54 **PackageIdentifier** property of the packages. 55 56 ### Example 3: Search for Microsoft.PowerShell by exact id 57 58 ```powershell 59 Find-WinGetPackage -Id Microsoft.PowerShell -MatchOption Equals 60 ``` 61 62 This example shows how to search for packages by exact package identifier. By default, the command 63 searches all configured sources. The command performs a case-sensitive full text match against the 64 **PackageIdentifier** property of the packages. 65 66 ## PARAMETERS 67 68 ### -Command 69 70 Specify the name of the command defined in the package manifest. 71 72 ```yaml 73 Type: System.String 74 Parameter Sets: (All) 75 Aliases: 76 77 Required: False 78 Position: Named 79 Default value: None 80 Accept pipeline input: True (ByPropertyName) 81 Accept wildcard characters: False 82 ``` 83 84 ### -Count 85 86 Specify the maximum number of results to return. 87 88 ```yaml 89 Type: System.UInt32 90 Parameter Sets: (All) 91 Aliases: 92 93 Required: False 94 Position: Named 95 Default value: None 96 Accept pipeline input: True (ByPropertyName) 97 Accept wildcard characters: False 98 ``` 99 100 ### -Id 101 102 Specify the package identifier to search for. By default, the command does a case-insensitive substring match. 103 104 ```yaml 105 Type: System.String 106 Parameter Sets: (All) 107 Aliases: 108 109 Required: False 110 Position: Named 111 Default value: None 112 Accept pipeline input: True (ByPropertyName) 113 Accept wildcard characters: False 114 ``` 115 116 ### -MatchOption 117 118 Specify matching logic used for search. The parameter accepts the following values: 119 120 - `Equals` 121 - `EqualsCaseInsensitive` 122 - `StartsWithCaseInsensitive` 123 - `ContainsCaseInsensitive` 124 125 ```yaml 126 Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption 127 Parameter Sets: (All) 128 Aliases: 129 Accepted values: Equals, EqualsCaseInsensitive, StartsWithCaseInsensitive, ContainsCaseInsensitive 130 131 Required: False 132 Position: Named 133 Default value: None 134 Accept pipeline input: True (ByPropertyName) 135 Accept wildcard characters: False 136 ``` 137 138 ### -Moniker 139 140 Specify the moniker of the package you are searching for. 141 142 ```yaml 143 Type: System.String 144 Parameter Sets: (All) 145 Aliases: 146 147 Required: False 148 Position: Named 149 Default value: None 150 Accept pipeline input: True (ByPropertyName) 151 Accept wildcard characters: False 152 ``` 153 154 ### -Name 155 156 Specify the name of the package to search for. 157 158 ```yaml 159 Type: System.String 160 Parameter Sets: (All) 161 Aliases: 162 163 Required: False 164 Position: Named 165 Default value: None 166 Accept pipeline input: True (ByPropertyName) 167 Accept wildcard characters: False 168 ``` 169 170 ### -Query 171 172 Specify one or more strings to search for. By default, the command searches all configured sources. 173 The command compares the value provided to the following package manifest properties: 174 - `PackageIdentifier` 175 - `PackageName` 176 - `Moniker` 177 - `Tags` 178 179 The command does a case-insensitive substring comparison of these properties. 180 181 ```yaml 182 Type: System.String[] 183 Parameter Sets: (All) 184 Aliases: 185 186 Required: False 187 Position: 0 188 Default value: None 189 Accept pipeline input: True (ByPropertyName) 190 Accept wildcard characters: False 191 ``` 192 193 ### -Source 194 195 Specify the name of the WinGet source to search. The most common sources are `msstore` and `winget`. 196 197 ```yaml 198 Type: System.String 199 Parameter Sets: (All) 200 Aliases: 201 202 Required: False 203 Position: Named 204 Default value: None 205 Accept pipeline input: True (ByPropertyName) 206 Accept wildcard characters: False 207 ``` 208 209 ### -Tag 210 211 Specify a package tag to search for. 212 213 ```yaml 214 Type: System.String 215 Parameter Sets: (All) 216 Aliases: 217 218 Required: False 219 Position: Named 220 Default value: None 221 Accept pipeline input: True (ByPropertyName) 222 Accept wildcard characters: False 223 ``` 224 225 ### CommonParameters 226 227 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, 228 -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, 229 -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see 230 [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 231 232 ## INPUTS 233 234 ### System.String 235 236 ### System.UInt32 237 238 ### System.String[] 239 240 ### Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption 241 242 ## OUTPUTS 243 244 ### Microsoft.WinGet.Client.Engine.PSObjects.PSFoundCatalogPackage 245 246 ## NOTES 247 248 ## RELATED LINKS 249 250 [Export-WinGetPackage](Export-WinGetPackage.md) 251 252 [Install-WinGetPackage](Install-WinGetPackage.md)