sources command (NuGet CLI)

  • Article

Applies to: package consumption, publishing • Supported versions: all

Manages the list of sources located in the user scope configuration file or a specified configuration file. The user scope configuration file is located at %appdata%\NuGet\NuGet.Config (Windows) and ~/.nuget/NuGet/NuGet.Config (Mac/Linux).

Note

Use package sources that you trust.

Note that the source URL for nuget.org is https://api.nuget.org/v3/index.json.

Usage

nuget sources <operation> -Name <name> -Source <source>

where <operation> is one of List, Add, Remove, Enable, Disable, or Update, <name> is the name of the source, and <source> is the source's URL. You can operate on only one source at a time.

Options

  • -ConfigFile

    The NuGet configuration file to apply. If not specified, %AppData%\NuGet\NuGet.Config (Windows), or ~/.nuget/NuGet/NuGet.Config or ~/.config/NuGet/NuGet.Config (Mac/Linux) is used. See On Mac/Linux, the user-level config file location varies by tooling..

  • -ForceEnglishOutput

    (3.5+) Forces nuget.exe to run using an invariant, English-based culture.

  • -Format

    Applies to the list action and can be Detailed (the default) or Short.

  • -?|-help

    Displays help information for the command.

  • -Name

    Name of the source.

  • -NonInteractive

    Suppresses prompts for user input or confirmations.

  • -Password

    Specifies the password for authenticating with the source.

    Note

    Be aware that encrypted passwords are only supported on Windows. Moreover, they can only be decrypted on the same machine and by the same user who originally encrypted them.

  • -src|-Source

    Path to the package(s) source.

  • -StorePasswordInClearText

    Indicates to store the password in unencrypted text instead of the default behavior of storing an encrypted form.

    Warning

    Storing passwords in clear text is strongly discouraged. For more information on managing credentials securely, refer to the security best practices for consuming packages from private feeds.

  • -UserName

    Specifies the user name for authenticating with the source.

  • -ValidAuthenticationTypes

    Comma-separated list of valid authentication types for this source. By default, all authentication types are valid. Example: basic,negotiate.

  • -ProtocolVersion

    The NuGet server protocol version to be used. See NuGet.Config's packageSources documentation for more information.

    Available in NuGet command line from version 6.8.

  • -Verbosity [normal|quiet|detailed]

    Specifies the amount of detail displayed in the output: normal (the default), quiet, or detailed.

  • -AllowInsecureConnections Allows HTTP connections for adding or updating packages. Note: This method is not secure. Available starting version 6.12.

Also see Environment variables

Examples

nuget sources Add -Name "MyServer" -Source \\myserver\packages

nuget sources Disable -Name "MyServer"

nuget sources Enable -Name "nuget.org"

nuget sources add -name foo.bar -source C:\NuGet\local -username foo -password bar -StorePasswordInClearText -configfile %AppData%\NuGet\my.config

nuget sources Update -Name "nuget.org" -ProtocolVersion 3