bb05cf5053
One commonly requested feature for Git LFS is support for local files. Currently, we tell users that they must use a standalone transfer agent, which is true, but nobody has provided one yet. Since writing a simple transfer agent is not very difficult, let's provide one ourselves. Introduce a basic standalone transfer agent, git lfs standalone-file, that handles uploads and downloads. Add a default configuration required for it to work, while still allowing users to override this configuration if they have a preferred implementation that is more featureful. We provide this as a transfer agent instead of built-in because it avoids the complexity of adding a different code path to the main codebase, but also serves as a demonstration of how to write a standalone transfer agent for others who might want to do so, much like Git demonstrates remote helpers using its HTTP helper.
23 lines
727 B
Markdown
23 lines
727 B
Markdown
git-lfs-standalone-file(1) -- Standalone transfer adapter for file URLs
|
|
=======================================================================
|
|
|
|
## SYNOPSIS
|
|
|
|
`git lfs standalone-file`
|
|
|
|
## DESCRIPTION
|
|
|
|
Provides a standalone transfer adapter for file URLs (local paths).
|
|
|
|
By default, Git LFS requires the support of an HTTP server to implement the Git
|
|
LFS protocol. However, this tool allows the use of URLs starting with `file:///`
|
|
(that is, those representing local paths) in addition. Configuration is not
|
|
necessary; Git LFS handles this internally.
|
|
|
|
When invoked, this tool speaks JSON on input and output as a standalone transfer
|
|
adapter. It is not intended for use by end users.
|
|
|
|
## SEE ALSO
|
|
|
|
Part of the git-lfs(1) suite.
|