Register-PSRepository
Registers a PowerShell repository.
Syntax
Register-PSRepository
-Name <String>
-SourceLocation <Uri>
[-PublishLocation <Uri>]
[-ScriptSourceLocation <Uri>]
[-ScriptPublishLocation <Uri>]
[-Credential <PSCredential>]
[-InstallationPolicy <String>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-PackageManagementProvider <String>]
[<CommonParameters>]
Register-PSRepository
[-Default]
[-InstallationPolicy <String>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[<CommonParameters>]
Description
The
Register-PSRepository
cmdlet registers the default repository for PowerShell modules.
After a repository is registered, you can reference it from the Find-Module, Install-Module, and Publish-Module cmdlets.
The registered repository becomes the default repository in
Find-Module
and
Install-Module
.
Registered repositories are user-specific.
They are not registered in a system-wide context.
Each registered repository is associated with a OneGet package provider, which is specified with the
PackageManagementProvider
parameter.
Each OneGet provider is designed to interact with a specific type of repository.
For example, the NuGet provider is designed to interact with NuGet-based repositories.
If a OneGet provider is not specified during registration, PowerShellGet attempts to find a OneGet provider that can handle the specified source location.
Examples
Example 1: Register a repository
PS C:\> Register-PSRepository -Name "myNuGetSource" -SourceLocation "https://www.myget.org/F/powershellgetdemo/api/v2" -PublishLocation "https://www.myget.org/F/powershellgetdemo/api/v2/Packages" -InstallationPolicy Trusted
PS C:\> Get-PSRepository
Name SourceLocation OneGetProvider InstallationPolicy
---- -------------- -------------- ------------------
PSGallery http://go.micro... NuGet Untrusted
myNuGetSource https://myget.c... NuGet Trusted
The first command registers
https://www.myget.org/F/powershellgetdemo/
as a repository for the current user.
After myNuGetSource is registered, you can explicitly reference it when searching for, installing, and publishing modules.
Because the
PackageManamentProvider
parameter isn't specified, the repository is not explicitly associated with a OneGet packkage provider, so PowerShellGet polls available package providers and associates it with the NuGet provider.
The second command gets registered repositories and displays the results.
Required Parameters
-Default
Type:
|
SwitchParameter
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
False
|
Accept wildcard characters:
|
False
|
-Name
Type:
|
String
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
False
|
Accept wildcard characters:
|
False
|
-SourceLocation
Type:
|
Uri
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
False
|
Accept wildcard characters:
|
False
|
Optional Parameters
-Credential
Type:
|
PSCredential
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
True (ByPropertyName)
|
Accept wildcard characters:
|
False
|
-InstallationPolicy
Type:
|
String
|
Parameter Sets:
|
Trusted, Untrusted
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
False
|
Accept wildcard characters:
|
False
|
-PackageManagementProvider
Type:
|
String
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
False
|
Accept wildcard characters:
|
False
|
-Proxy
Type:
|
Uri
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
True (ByPropertyName)
|
Accept wildcard characters:
|
False
|
-ProxyCredential
Type:
|
PSCredential
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
True (ByPropertyName)
|
Accept wildcard characters:
|
False
|
-PublishLocation
Type:
|
Uri
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
False
|
Accept wildcard characters:
|
False
|
-ScriptPublishLocation
Type:
|
Uri
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
False
|
Accept wildcard characters:
|
False
|
-ScriptSourceLocation
Type:
|
Uri
|
Position:
|
Named
|
Default value:
|
None
|
Accept pipeline input:
|
False
|
Accept wildcard characters:
|
False
|