Sitecore Experience Management

Sitecore PowerShell public NuGet feed FAQ

Abstract

FAQ about Sitecore PowerShell NuGet packages

Sitecore distributes PowerShell modules as NuGet packages.

Here are the answers to the most frequently asked questions about using Sitecore PowerShell modules:

Question

Answer

What is the URL of the NuGet feed?

The URLs for the NuGet feeds is:

https://sitecore.myget.org/F/sc-powershell/api/v2

When are the packages available?

Sitecore intends to make packages available as soon as the releases are available.

However, Sitecore does not guarantee that the NuGet packages will be available at the same time as the product, module, or version is released.

What about hotfixes?

Only major, minor, and patch releases will be made following Semver principles.

Will there be a private feed for MVPs who get the release early?

We have no plans for a separate MVP feed yet.

What about external references?

Packages with dependencies to external content will install those dependencies whenever possible.

What is actually in the packages?

The packages are built to conform to the requirements for PowerShellGet

Where is the Sitecore license for PowerShell modules hosted on MyGet?

You can find the license file here: Sitecore MyGet License Agreement.

How do I register the PowerShell NuGet repository?

To install Sitecore PowerShell modules, you must register the PowerShell NuGet repository. You only need to register the repository only once.

To register the PowerShell NuGet repository:

  1. Launch PowerShell as an administrator.

  2. In the PowerShell command line, run the following cmdlet:

    Register-PSRepository -Name SitecoreGallery -SourceLocation https://sitecore.myget.org/F/sc-powershell/api/v2
    

    Repositories are registered as untrusted by default and you must therefore approve every module that you want to install.

  3. To register your repository as trusted and automatically approve the installation of any module, run the following cmdlet:

    Set-PSRepository -Name SitecoreGallery -InstallationPolicy Trusted
    

How do I install a module?

After you register the repository, you can use it to install modules.

For example, to install the SitecoreInstallFramework module:

  1. Launch PowerShell as an administrator.

  2. In the PowerShell command line, run the following cmdlet:

    Install-Module -Name SitecoreInstallFramework -Repository SitecoreGallery
    

    Modules are installed for all users by default.

    To install the module for the current user only, append -Scope CurrentUser to the previous cmdlet.

How do I update a module?

New versions of the modules are pushed to the same repository. You can then update the module to get the latest version.

For example, to update the SitecoreInstallFramework module:

  1. Launch PowerShell as an administrator.

  2. In the PowerShell command line, run the following cmdlet:

    Update-Module SitecoreInstallFramework