Package Manager Console Powershell Reference

The Package Manager Console is a PowerShell console within Visual Studio used to interact with NuGet and automate Visual Studio. Note that for more detailed help, you can run the Get-Help CommandName from within the NuGet Package Manager Console in Visual Studio.

Add-BindingRedirect

Adds binding redirects to the config file.

Add-BindingRedirect [-ProjectName] <string>

Examines all assemblies within the output path for a project and adds binding redirects to the application (or web) configuration file where necessary. NOTE: As of NuGet 1.2, NuGet automatically runs this command when installing a package.

PARAMETERS
    -ProjectName 
        Specifies the project to analyze and add binding redirects to.

        Required: true

Examples

PM> Add-BindingRedirect MyProjectName

Adds binding redirects to the specified project, MyProjectName.

Get-Package

Gets the set of packages available from the package source. Use the -ListAvailable flag to list packages available from the package source.

Get-Package -Source <string> [-ListAvailable] [-Updates] [-ProjectName] [-Recent] [-Filter <string>] [-First <int>] [-Skip <int>] [-AllVersions]

Gets the set of packages available from the package source. Defaults to only showing the list of installed packages. Use the -ListAvailable flag to list packages available from the package source.

PARAMETERS
    -Source 
        Specifies the URL or directory path for the package source containing the package to install. 
        If omitted, looks in the currently selected package source to find the corresponding package URL.

        Required: false

    -ListAvailable
        Gets packages available from the online package source.

        Required: false

    -Recent
        Gets the list of recently installed packages.

        Required: false

    -Updates
        Gets packages that have an update available from the package source.

        Required: false

    -ProjectName
        Specifies the project to get installed packages from. If omitted, the command will return installed projects for the entire solution.

        Required: false

    -Filter
        Specifies a filter string used to narrow down the list of packages returned. The filter is searched 
        for in the package Id, the description and tags.

        Required: false

    -First
        Specifies the number of packages to return from the beginning of the list.

        Required: false

    -Skip
        Skips (does not return) the specified number of packages, counting from the beginning of the list.

        Required: false

    -AllVersions
        Displays all available versions of a package. The latest version of each package is listed by default.

        Required: false

    -IncludePrerelease
        Indicates whether to include prerelease packages in the returned results.

        Required: false

Examples

PM> Get-Package

Returns the packages installed in the default project.

PM> Get-Package -ListAvailable

Returns a list of packages available online in the current package source.

PM> Get-Package -ListAvailable -Filter Ninject

Returns a list of packages available online using "Ninject" as a search term.

PS> Get-Package -Updates

Returns a list of packages installed in the default project that have updates available in the current package source.

PM> Get-Package -Recent

Returns a list of recently installed packages.

Get-Project

Gets the specified project. If none is specified, returns the default project.

Get-Project [[-Name] <string>] [-All]

Returns a reference to the DTE (Development Tools Environment) for the specified project. If none is specified, returns the default project selected in the Package Manager Console.

  

PARAMETERS
    -Name 
        Specifies the project to return. If omitted, the default project selected in the Package Manager Console is returned.

        Required: false

    -All
        Returns every project in the solution.

        Required: false

Examples

PM> Get-Project

Returns a reference to the default project.

PM> Get-Project MyProjectName

Returns a reference to the specified project, MyProjectName.

PM> Get-Project -All

Returns a reference to every project in the solution.

Install-Package

Installs a package.

Install-Package [-Id] [-IgnoreDependencies] [-ProjectName ] [-Version ] [-Source ]

Installs a package and its dependencies into the project.

PARAMETERS
    -Id 
        Specifies the package ID of the package to install.

        Required: true

    -IgnoreDependencies
        Installs only this package and not its dependencies.

        Required: false

    -ProjectName 
        Specifies the project to install the package into. If omitted, the default project is chosen.

        Required: false

    -Source 
        Specifies the URL or directory path for the package source containing the package to install. If omitted, 
        looks in the currently selected package source 
        to find the corresponding package URL.

        Required: false

    -Version 
        Specifies the version of the package to install. If omitted, defaults to the latest version.

        Required: false

    -IncludePrerelease
        Indicates whether this command will consider prerelease packages. If omitted, only 
        stable packages are considered.

        Required: false

Examples

PM> Install-Package Elmah

Installs the latest version of the Elmah package from the current package source into the default project.

PM> Install-Package Glimpse -Version 1.0.0 -Project MvcApplication1

Installs version 1.0.0 of Glimpse into the project named MvcApplication1

PM> Install-Package Ninject.Mvc3 -IgnoreDependencies -Source c:\temp\packages

Installs the package, Ninject.Mvc3, but not its dependencies. It looks in the directory, c:\temp\packages to find the package.

New-Package

Creates a package.

New-Package [[-ProjectName] <string>] [-SpecFileName] <string> [-TargetFile] <string> [-NoClobber]

Creates a new package when supplied with a Nuspec package specification file.

    
PARAMETERS
    -ProjectName 
        Specifies the project containing the NuSpec file to use when creating the package. If omitted, the current 
        project selected in the console is used.

        Required: false

    -SpecFileName 
        Specifies the NuSpec file used to create the package. If omitted, the NuSpec file within the current project 
        is used if there is only one such file.

        Required: true

    -TargetFile 
        Specifes the full name of the output NuPkg file.

        Required: true

    -NoClobber
        If specified, the target file is not overwritten.

        Required: false

Examples

PM> New-Package

Creates a new package based on the current project using a Nuspec file within the project if only one such file is found.

PM> New-Package -Project MyProjectName -SpecFileName MyPackage.nuspec

Creates a new package from the specified project, MyProjectName using the specified Nuspec file, MyPackage.nuspec.

Open-PackagePage

Open the browser pointing to ProjectUrl, LicenseUrl or ReportAbuseUrl of the specified package.

Open-PackagePage -Id <string> [-Version] [-Source] [-License] [-ReportAbuse] [-PassThru]

Open the browser pointing to ProjectUrl, LicenseUrl or ReportAbuseUrl of the specified package.

PARAMETERS
    -Id 
        Specifies the Id of the package to search for.

        Required: false

    -Version
        Specifies the version of the package to search for. If omitted, defaults to the latest version.

        Required: false

    -Source
        Specifies the source of the repository to search for package. If omitted, defaults to the selected source in 
        the package source dropdown control.

        Required: false

    -License
        Indicates the cmdlet should open the LicenseUrl of the specified package. If neither LicenseUrl nor ReportAbuseUrl 
        is set, the cmdlet will open the Proje
        ctUrl by default.

        Required: false

    -ReportAbuse
        Indicates the cmdlet should open the ReportAbuseUrl of the specified package. If neither LicenseUrl nor ReportAbuseUrl 
        is set, the cmdlet will open the P
        rojectUrl by default.

        Required: false

    -PassThru
        If specified, the cmdlet will return the value of the requested URL.

        Required: false

Examples

PM> Open-PackagePage Ninject

Opens a browser to the project URL specified in the Ninject package.

PM> Open-PackagePage Ninject -License

Opens a browser to the license URL specified in the Ninject package.

PM> Open-PackagePage Ninject -ReportAbuse

Opens a browser to the URL at the current package source used to report abuse for the specified package.

PM> $url = Open-PackagePage Ninject -License -WhatIf -PassThru

Assigns the license URL to the variable, $url, without opening the URL in a browser.

Uninstall-Package

Uninstalls a package.

Uninstall-Package [-Id] <string> [-RemoveDependencies] [-Force] [-Version <string>]

Uninstalls a package. If other packages depend on this package, the command will fail unless the –Force option is specified.

    

PARAMETERS
    -Id 
        Specifies the package ID of the package to uninstall.

        Required: true

    -RemoveDependencies
        Uninstalls the package and its unused dependencies.

        Required: false

    -ProjectName 
        Specifies the project to uninstall the package from. If omitted, the default project is chosen.

        Required: false

    -Version 
        The version of the package to uninstall. If omitted, defaults to the latest version.

        Required: false

Examples

PM> Uninstall-Package Elmah

Uninstalls the Elmah package from the default project.

PM> Uninstall-Package Elmah -RemoveDependencies

Uninstalls the Elmah package as well as all its dependencies. If any dependency has another package that depends on it, it is skipped.

PM> Uninstall-Package Elmah -Force

Uninstalls the Elmah package even if another package depends on it.

Update-Package

Updates a package.

Update-Package [-Id] <string> [-IgnoreDependencies] [-ProjectName <string>] [-Version <string>] [-Source <string>] [-Safe]

Updates a package and its dependencies to a newer version.

PARAMETERS
    -Id 
        Specifies the package ID of the package to update.

        Required: false

    -IgnoreDependencies
        Updates all of the package’s dependencies to the latest version. False by default.

        Required: false

    -ProjectName 
        Specifies the project containing the project to update. If omitted, all projects are updated.

        Required: false

    -Safe 
        The `-Safe` flag constrains upgrades to only versions with the same Major and Minor version component. 

       Required: false

    -Source 
        Specifies the URL or directory path for the package source containing the package to install. If omitted, 
        looks in the currently selected package source to find the corresponding package URL.

        Required: false

    -Version 
        Specifies the version that the package will be upgraded to. If omitted, defaults to the latest version.

       Required: false

    -IncludePrerelease
        Indicates whether to include prereleases when searching for updates. If omitted, only 
        stable packages are considered.

        Required: false

Examples

PM> Update-Package Elmah

Updates the Elmah package in every project to the latest version.

PM> Update-Package Elmah -Version 1.1.0

Updates the Elmah package to a specific version in every project.

PM> Update-Package Elmah -Project MvcApplication1

Updates the Elmah package within the MvcApplication1 project.

PM> Update-Package

Updates every package in every project.

PM> Update-Package -Project MvcApplication1

Updates every package in the MvcApplication1 project.

PM> Update-Package Elmah -Safe

Updates Elmah to the highest "safe" version. For example, if Elmah version 1.0.0 of a package is installed, and versions 1.0.1, 1.0.2, and 1.1 are available in the feed, the -Safe flag updates the package to 1.0.2 instead of 1.1 as it would without the flag.