Paket


HTTP dependencies

Paket allows one to automatically manage the linking of files from HTTP resources into your projects.

Referencing a single file

You can reference a single file from a HTTP resource simply by specifying the URL in the paket.dependencies file:

1: 
http http://www.fssnip.net/raw/1M/test1.fs

If you run the paket install command, it will add a new section to your paket.lock file:

1: 
2: 
3: 
HTTP
  remote: http://www.fssnip.net/raw/1M/test1.fs
    test1.fs

If you want to reference the file in one of your project files then add an entry to the project's paket.references file.:

1: 
File: test1.fs

This will reference the linked file directly into your project. By default the linked file will be visible under paket-files folder in project.

Build action conventions

The build action is determined depending on the file extension:

  • If file extension is equal to project type it is added as compile items. For instance .cs for .csproj projects and .fs for .fsproj projects.
  • If file extension is .dll then it is added as reference.
  • Otherwise it is added as an 'add as link' content file.

Options on http dependencies

When referencing a file using a http dependency, there are several options that help you to deal with things like authentication and file name. The pattern expected is

1: 
http url [FileSpec] [SourceName]
  • FileSpec - This allows you to define the path to which the file that is downloaded will be written to. For example specifying the following

    [lang=paket] http http://www.fssnip.net/raw/1M/test1.fs src/test1.fs

    will write the file to paket-files\www.fssnip.net\src\test.fs

  • SourceName - The source name allows you to override the folder which the downloaded file is written to and also acts as a key to lookup any authentication that maybe associated for that key. For example if I had added an authentication source using paket config add-authentication MySource then each time Paket extracts a HTTP dependency with MySource as a SourceName the credentials will be made part of the HTTP request. If no keys exist in the authentication store then the request will be made without any authentication headers.

Allowed http schemes

All http, https and file protocol URIs are allowed. Examples:

Updating http dependencies

If you want to update a file you need to use the paket install command or paket update command with --force [-f] option.

Using groups for http dependent files can be helpful in order to reduce the number of files that are re-installed.

Fork me on GitHub