dotnet-installer/Documentation/manpages/sdk/dotnet-nuget-push.1
2018-05-30 15:52:55 +00:00

208 lines
6.1 KiB
Groff

.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "dotnet nuget push command \- .NET Core CLI" "1" "" "" ".NET Core"
.hy
.SH dotnet nuget push
.PP
.SH NAME
.PP
\f[C]dotnet\ nuget\ push\f[] \- Pushes a package to the server and publishes it.
.SH SYNOPSIS
.SS .NET Core 2.1
.IP
.nf
\f[C]
dotnet\ nuget\ push\ [<ROOT>]\ [\-d|\-\-disable\-buffering]\ [\-\-force\-english\-output]\ [\-k|\-\-api\-key]\ [\-n|\-\-no\-symbols]
\ \ \ \ [\-\-no\-service\-endpoint]\ [\-s|\-\-source]\ [\-sk|\-\-symbol\-api\-key]\ [\-ss|\-\-symbol\-source]\ [\-t|\-\-timeout]
dotnet\ nuget\ push\ [\-h|\-\-help]
\f[]
.fi
.SS .NET Core 2.0
.IP
.nf
\f[C]
dotnet\ nuget\ push\ [<ROOT>]\ [\-d|\-\-disable\-buffering]\ [\-\-force\-english\-output]\ [\-k|\-\-api\-key]\ [\-n|\-\-no\-symbols]
\ \ \ \ [\-s|\-\-source]\ [\-sk|\-\-symbol\-api\-key]\ [\-ss|\-\-symbol\-source]\ [\-t|\-\-timeout]
dotnet\ nuget\ push\ [\-h|\-\-help]
\f[]
.fi
.SS .NET Core 1.x
.IP
.nf
\f[C]
dotnet\ nuget\ push\ [<ROOT>]\ [\-d|\-\-disable\-buffering]\ [\-\-force\-english\-output]\ [\-k|\-\-api\-key]\ [\-n|\-\-no\-symbols]
\ \ \ \ [\-s|\-\-source]\ [\-sk|\-\-symbol\-api\-key]\ [\-ss|\-\-symbol\-source]\ [\-t|\-\-timeout]
dotnet\ nuget\ push\ [\-h|\-\-help]
\f[]
.fi
.PP
* * * * *
.SH DESCRIPTION
.PP
The \f[C]dotnet\ nuget\ push\f[] command pushes a package to the server and publishes it.
The push command uses server and credential details found in the system's NuGet config file or chain of config files.
For more information on config files, see Configuring NuGet Behavior.
NuGet's default configuration is obtained by loading \f[I]%AppData%.config\f[] (Windows) or \f[I]$HOME/.local/share\f[] (Linux/macOS), then loading any \f[I]nuget.config\f[] or \f[I].nuget.config\f[] starting from the root of drive and ending in the current directory.
.SS Arguments
.PP
\f[C]ROOT\f[]
.PP
Specifies the file path to the package to be pushed.
.SH OPTIONS
.SS .NET Core 2.1
.PP
\f[C]\-d|\-\-disable\-buffering\f[]
.PP
Disables buffering when pushing to an HTTP(S) server to reduce memory usage.
.PP
\f[C]\-\-force\-english\-output\f[]
.PP
Forces the application to run using an invariant, English\-based culture.
.PP
\f[C]\-h|\-\-help\f[]
.PP
Prints out a short help for the command.
.PP
\f[C]\-k|\-\-api\-key\ <API_KEY>\f[]
.PP
The API key for the server.
.PP
\f[C]\-n|\-\-no\-symbols\f[]
.PP
Doesn't push symbols (even if present).
.PP
\f[C]\-\-no\-service\-endpoint\f[]
.PP
Doesn't append \[lq]api/v2/packages\[rq] to the source URL.
.PP
\f[C]\-s|\-\-source\ <SOURCE>\f[]
.PP
Specifies the server URL.
This option is required unless \f[C]DefaultPushSource\f[] config value is set in the NuGet config file.
.PP
\f[C]\-sk|\-\-symbol\-api\-key\ <API_KEY>\f[]
.PP
The API key for the symbol server.
.PP
\f[C]\-ss|\-\-symbol\-source\ <SOURCE>\f[]
.PP
Specifies the symbol server URL.
.PP
\f[C]\-t|\-\-timeout\ <TIMEOUT>\f[]
.PP
Specifies the timeout for pushing to a server in seconds.
Defaults to 300 seconds (5 minutes).
Specifying 0 (zero seconds) applies the default value.
.SS .NET Core 2.0
.PP
\f[C]\-d|\-\-disable\-buffering\f[]
.PP
Disables buffering when pushing to an HTTP(S) server to reduce memory usage.
.PP
\f[C]\-\-force\-english\-output\f[]
.PP
Forces the application to run using an invariant, English\-based culture.
.PP
\f[C]\-h|\-\-help\f[]
.PP
Prints out a short help for the command.
.PP
\f[C]\-k|\-\-api\-key\ <API_KEY>\f[]
.PP
The API key for the server.
.PP
\f[C]\-n|\-\-no\-symbols\f[]
.PP
Doesn't push symbols (even if present).
.PP
\f[C]\-s|\-\-source\ <SOURCE>\f[]
.PP
Specifies the server URL.
This option is required unless \f[C]DefaultPushSource\f[] config value is set in the NuGet config file.
.PP
\f[C]\-sk|\-\-symbol\-api\-key\ <API_KEY>\f[]
.PP
The API key for the symbol server.
.PP
\f[C]\-ss|\-\-symbol\-source\ <SOURCE>\f[]
.PP
Specifies the symbol server URL.
.PP
\f[C]\-t|\-\-timeout\ <TIMEOUT>\f[]
.PP
Specifies the timeout for pushing to a server in seconds.
Defaults to 300 seconds (5 minutes).
Specifying 0 (zero seconds) applies the default value.
.SS .NET Core 1.x
.PP
\f[C]\-d|\-\-disable\-buffering\f[]
.PP
Disables buffering when pushing to an HTTP(S) server to reduce memory usage.
.PP
\f[C]\-\-force\-english\-output\f[]
.PP
Forces the application to run using an invariant, English\-based culture.
.PP
\f[C]\-h|\-\-help\f[]
.PP
Prints out a short help for the command.
.PP
\f[C]\-k|\-\-api\-key\ <API_KEY>\f[]
.PP
The API key for the server.
.PP
\f[C]\-n|\-\-no\-symbols\f[]
.PP
Doesn't push symbols (even if present).
.PP
\f[C]\-s|\-\-source\ <SOURCE>\f[]
.PP
Specifies the server URL.
This option is required unless \f[C]DefaultPushSource\f[] config value is set in the NuGet config file.
.PP
\f[C]\-sk|\-\-symbol\-api\-key\ <API_KEY>\f[]
.PP
The API key for the symbol server.
.PP
\f[C]\-ss|\-\-symbol\-source\ <SOURCE>\f[]
.PP
Specifies the symbol server URL.
.PP
\f[C]\-t|\-\-timeout\ <TIMEOUT>\f[]
.PP
Specifies the timeout for pushing to a server in seconds.
Defaults to 300 seconds (5 minutes).
Specifying 0 (zero seconds) applies the default value.
.PP
* * * * *
.SH EXAMPLES
.PP
Pushes \f[I]foo.nupkg\f[] to the default push source, specifying an API key:
.PP
\f[C]dotnet\ nuget\ push\ foo.nupkg\ \-k\ 4003d786\-cc37\-4004\-bfdf\-c4f3e8ef9b3a\f[]
.PP
Push \f[I]foo.nupkg\f[] to the custom push source \f[C]http://customsource\f[], specifying an API key:
.PP
\f[C]dotnet\ nuget\ push\ foo.nupkg\ \-k\ 4003d786\-cc37\-4004\-bfdf\-c4f3e8ef9b3a\ \-s\ http://customsource/\f[]
.PP
Pushes \f[I]foo.nupkg\f[] to the default push source:
.PP
\f[C]dotnet\ nuget\ push\ foo.nupkg\f[]
.PP
Pushes \f[I]foo.symbols.nupkg\f[] to the default symbols source:
.PP
\f[C]dotnet\ nuget\ push\ foo.symbols.nupkg\f[]
.PP
Pushes \f[I]foo.nupkg\f[] to the default push source, specifying a 360\-second timeout:
.PP
\f[C]dotnet\ nuget\ push\ foo.nupkg\ \-\-timeout\ 360\f[]
.PP
Pushes all \f[I].nupkg\f[] files in the current directory to the default push source:
.PP
\f[C]dotnet\ nuget\ push\ *.nupkg\f[]
.PP
Pushes all \f[I].nupkg\f[] files in the current directory to the default push source, specifying a custom config file \f[I]./config/My.Config\f[]:
.PP
\f[C]dotnet\ nuget\ push\ *.nupkg\ \-\-config\-file\ ./config/My.Config\f[]
.SH AUTHORS
karann\-msft.