dotnet-installer/src/dotnet/commands/dotnet-restore/README.md
Zlatko Knezevic c83a2fb6f9 Add and modify commands' README files (#2338)
* Add and modify commands' README files

Update those READMEs that are outdated. Add READMEs for dotnet pack
and dotnet restore as well.

* Removing private info, adding feedback alias
2016-04-15 10:36:31 -07:00

2.9 KiB

% DOTNET-RESTORE(1) % Microsoft Corporation dotnetclifeedback@microsoft.com % April 2016

NAME

dotnet-restore - restores the dependencies and tools of a project

SYNOPSIS

dotnet-restore [--source]
[--packages] [--disable-parallel]
[--fallbacksource] [--configfile] [--verbosity] [< root >]

DESCRIPTION

dotnet-restore will use NuGet to restore dependencies as well as project-specific tools that are specified in the project.json file. By default, the restoration of dependencies and tools will be done in parallel.

In order to restore the dependencies, NuGet needs feeds where the packages are located. Feeds are usually provided via the NuGet.config configuration file; a default one is present when CLI tools are installed. You can specify more feeds by creating your own NuGet.config file in the project directory. Feeds can also be specified per invocation on the command line.

For dependencies, you can specify where the restored packages will be placed during the restore operation using the --packages argument. If not specified, the default NuGet package cache will be used. It is found in the .nuget/packages directory in the user's home directory on all operating systems (for example /home/user1 on Linux or C:\Users\user1 on Windows).

For project-specific tooling, dotnet-restore will first restore the package in which the tool is packed, and will then proceed to restore the tool's dependencies as specified in its project.json.

OPTIONS

[root]

A list of projects or project folders to restore. The list can contain either a path to a project.json file, path to global.json file or folder. The restore operation will run recursivelly for all subdirectories and restore for each given project.json file it finds.

-s, --source [SOURCE]

Specify a source to use during the restore operation. This will override all of the sources specified in the NuGet.config file(s).

--packages [DIR]

Specifies the directory to place the restored packages in.

--disable-parallel

Disable restoring multiple projects in parallel.

-f, --fallbacksource [FEED]

Specify a fallback source that will be used in the restore operation if all other sources fail. All valid feed formats are allowed.

--configfile [FILE]

Configuration file (NuGet.config) to use for this restore operation.

--verbosity [LEVEL]

The verbosity of logging to use. Allowed values: Debug, Verbose, Information, Minimal, Warning, Error.

EXAMPLES

dotnet-restore

Restore dependencies and tools for the project in the current directory.

dotnet-restore ~/projects/app1/project.json

Restore dependencies and tools for the app1 project found in the given path.

dotnet-restore --f c:\packages\mypackages

Restore the dependencies and tools for the project in the current directory using the file path provided as the fallback source.

dotnet-restore --verbosity Error

Show only errors in the output.

SEE ALSO

dotnet