1dotnet restore command(1) .NET Core dotnet restore command(1)
2
7 dotnet restore - Restores the dependencies and tools of a project.
8
10 .NET Core 2.x
11 dotnet restore [<ROOT>] [--configfile] [--disable-parallel] [--force] [--ignore-failed-sources] [--no-cache]
12 [--no-dependencies] [--packages] [-r|--runtime] [-s|--source] [-v|--verbosity] [--interactive]
13 dotnet restore [-h|--help]
14 .NET Core 1.x
16 dotnet restore [<ROOT>] [--configfile] [--disable-parallel] [--ignore-failed-sources] [--no-cache]
17 [--no-dependencies] [--packages] [-r|--runtime] [-s|--source] [-v|--verbosity]
18 dotnet restore [-h|--help]
19 * * * * *
21
23 The dotnet restore command uses NuGet to restore dependencies as well
24 as project-specific tools that are specified in the project file. By
25 default, the restoration of dependencies and tools are executed in par‐
26 allel.
27 To restore the dependencies, NuGet needs the feeds where the packages
29 are located. Feeds are usually provided via the nuget.config configu‐
30 ration file. A default configuration file is provided when the CLI
31 tools are installed. You specify additional feeds by creating your own
32 nuget.config file in the project directory. You also specify addition‐
33 al feeds per invocation at a command prompt.
34 For dependencies, you specify where the restored packages are placed
36 during the restore operation using the --packages argument. If not
37 specified, the default NuGet package cache is used, which is found in
38 the .nuget/packages directory in the user’s home directory on all oper‐
39 ating systems. For example, /home/user1 on Linux or C:1 on Windows.
40 For project-specific tooling, dotnet restore first restores the package
42 in which the tool is packed, and then proceeds to restore the tool’s
43 dependencies as specified in its project file.
44 nuget.config differences
46 The behavior of the dotnet restore command is affected by the settings
47 in the nuget.config file, if present. For example, setting the global‐
48 PackagesFolder in nuget.config places the restored NuGet packages in
49 the specified folder. This is an alternative to specifying the --pack‐
50 ages option on the dotnet restore command. For more information, see
51 the nuget.config reference.
52 There are three specific settings that dotnet restore ignores:
54 · bindingRedirects
56 Binding redirects don’t work with <PackageReference> elements and
58 .NET Core only supports <PackageReference> elements for NuGet pack‐
59 ages.
60 · solution
62 This setting is Visual Studio specific and doesn’t apply to .NET
64 Core. .NET Core doesn’t use a packages.config file and instead uses
65 <PackageReference> elements for NuGet packages.
66 · trustedSigners
68 This setting isn’t applicable as NuGet doesn’t yet support cross-
70 platform verification of trusted packages.
71 Implicit dotnet restore
73 Starting with .NET Core 2.0, dotnet restore is run implicitly if neces‐
74 sary when you issue the following commands:
75 · dotnet new
77 · dotnet build
79 · dotnet build-server
81 · dotnet run
83 · dotnet test
85 · dotnet publish
87 · dotnet pack
89 In most cases, you no longer need to explicitly use the dotnet restore
91 command.
92 Sometimes, it might be inconvenient to run dotnet restore implicitly.
94 For example, some automated systems, such as build systems, need to
95 call dotnet restore explicitly to control when the restore occurs so
96 that they can control network usage. To prevent dotnet restore from
97 running implicitly, you can use the --no-restore flag with any of these
98 commands to disable implicit restore.
99 Arguments
101 ROOT
102 Optional path to the project file to restore.
104
106 .NET Core 2.x
107 --configfile <FILE>
108 The NuGet configuration file (nuget.config) to use for the restore op‐
110 eration.
111 --disable-parallel
113 Disables restoring multiple projects in parallel.
115 --force
117 Forces all dependencies to be resolved even if the last restore was
119 successful. Specifying this flag is the same as deleting the
120 project.assets.json file.
121 -h|--help
123 Prints out a short help for the command.
125 --ignore-failed-sources
127 Only warn about failed sources if there are packages meeting the ver‐
129 sion requirement.
130 --no-cache
132 Specifies to not cache packages and HTTP requests.
134 --no-dependencies
136 When restoring a project with project-to-project (P2P) references, re‐
138 stores the root project and not the references.
139 --packages <PACKAGES_DIRECTORY>
141 Specifies the directory for restored packages.
143 -r|--runtime <RUNTIME_IDENTIFIER>
145 Specifies a runtime for the package restore. This is used to restore
147 packages for runtimes not explicitly listed in the <RuntimeIdentifiers>
148 tag in the .csproj file. For a list of Runtime Identifiers (RIDs), see
149 the RID catalog. Provide multiple RIDs by specifying this option mul‐
150 tiple times.
151 -s|--source <SOURCE>
153 Specifies a NuGet package source to use during the restore operation.
155 This setting overrides all of the sources specified in the nuget.config
156 files. Multiple sources can be provided by specifying this option mul‐
157 tiple times.
158 --verbosity <LEVEL>
160 Sets the verbosity level of the command. Allowed values are q[uiet],
162 m[inimal], n[ormal], d[etailed], and diag[nostic]. Default value is
163 minimal.
164 --interactive
166 Allows the command to stop and wait for user input or action (for exam‐
168 ple to complete authentication). Since .NET Core 2.1.400.
169 .NET Core 1.x
171 --configfile <FILE>
172 The NuGet configuration file (nuget.config) to use for the restore op‐
174 eration.
175 --disable-parallel
177 Disables restoring multiple projects in parallel.
179 -h|--help
181 Prints out a short help for the command.
183 --ignore-failed-sources
185 Only warn about failed sources if there are packages meeting the ver‐
187 sion requirement.
188 --no-cache
190 Specifies to not cache packages and HTTP requests.
192 --no-dependencies
194 When restoring a project with project-to-project (P2P) references, re‐
196 stores the root project and not the references.
197 --packages <PACKAGES_DIRECTORY>
199 Specifies the directory for restored packages.
201 -r|--runtime <RUNTIME_IDENTIFIER>
203 Specifies a runtime for the package restore. This is used to restore
205 packages for runtimes not explicitly listed in the <RuntimeIdentifiers>
206 tag in the .csproj file. For a list of Runtime Identifiers (RIDs), see
207 the RID catalog. Provide multiple RIDs by specifying this option mul‐
208 tiple times.
209 -s|--source <SOURCE>
211 Specifies a NuGet package source to use during the restore operation.
213 This overrides all of the sources specified in the nuget.config files,
214 effectively reading the nuget.config file as if the <packageSource> el‐
215 ement was not there. Multiple sources can be provided by specifying
216 this option multiple times.
217 --verbosity <LEVEL>
219 Sets the verbosity level of the command. Allowed values are q[uiet],
221 m[inimal], n[ormal], d[etailed], and diag[nostic]. The default is min‐
222 imal.
223 * * * * *
225
227 Restore dependencies and tools for the project in the current directo‐
228 ry:
229 dotnet restore
231 Restore dependencies and tools for the app1 project found in the given
233 path:
234 dotnet restore ~/projects/app1/app1.csproj
236 Restore the dependencies and tools for the project in the current di‐
238 rectory using the file path provided as the source:
239 dotnet restore -s c:\packages\mypackages
241 Restore the dependencies and tools for the project in the current di‐
243 rectory using the two file paths provided as sources:
244 dotnet restore -s c:\packages\mypackages -s c:\packages\myotherpackages
246 Restore dependencies and tools for the project in the current directory
248 showing detailed output:
249 dotnet restore --verbosity detailed
251 dotnet restore command(1)