Documentation
¶
Overview ¶
Package lfs git-lfs - Work with large files in Git repositories.
SYNOPSIS ¶
Reference: https://git-lfs.github.com/
git lfs command [args]
DESCRIPTION ¶
Git LFS is a system for managing and versioning large files in association with a Git repository. Instead of storing the large files within the Git repository as blobs, Git LFS stores special "pointer files" in the repository, while storing the actual file contents on a Git LFS server. The contents of the large file are downloaded automatically when needed, for example when a Git branch containing the large file is checked out.
Git LFS works by using a "smudge" filter to look up the large file contents based on the pointer file, and a "clean" filter to create a new version of the pointer file when the large file's contents change. It also uses a pre-push hook to upload the large file contents to the Git LFS server whenever a commit containing a new large file version is about to be pushed to the corresponding Git server.
COMMANDS ¶
Like Git, Git LFS commands are separated into high level ("porcelain") commands and low level ("plumb- ing") commands.
Index ¶
- func Checkout(object string) types.Option
- func Clean(object string) types.Option
- func Dedup(object string) types.Option
- func Env(object string) types.Option
- func Ext(object string) types.Option
- func Fetch(object string) types.Option
- func Fsck(object string) types.Option
- func Install(object string) types.Option
- func Lock(object string) types.Option
- func Locks(object string) types.Option
- func Logs(object string) types.Option
- func LsFiles(object string) types.Option
- func Migrate(object string) types.Option
- func Pointer(object string) types.Option
- func PostCheckout(object string) types.Option
- func PostCommit(object string) types.Option
- func PostMerge(object string) types.Option
- func PreMerge(object string) types.Option
- func PrePush(object string) types.Option
- func Process(object string) types.Option
- func Prune(object string) types.Option
- func Pull(object string) types.Option
- func Push(object string) types.Option
- func Smudge(object string) types.Option
- func StandaloneFile(object string) types.Option
- func Status(object string) types.Option
- func Track(object string) types.Option
- func Uninstall(object string) types.Option
- func Unlock(object string) types.Option
- func Untrack(object string) types.Option
- func Update(object string) types.Option
- func Version(object string) types.Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func LsFiles ¶
Show information about Git LFS files in the index and working tree. usage: git lfs ls-files
func PostCheckout ¶
Git post-checkout hook implementation. usage: git lfs post-checkout
func PostCommit ¶
Git post-commit hook implementation. usage: git lfs post-commit
func Process ¶
Git process filter that converts between large files and pointers. usage: git lfs process
func Pull ¶
Fetch Git LFS changes from the remote & checkout any required working tree files. usage: git lfs pull
func Smudge ¶
Git smudge filter that converts pointer in blobs to the actual content. usage: git lfs smudge
func StandaloneFile ¶
Git LFS standalone transfer adapter for file URLs (local paths). usage: git lfs standalone-file
func Uninstall ¶
Uninstall Git LFS by removing hooks and smudge/clean filter configuration. usage: git lfs uninstall
Types ¶
This section is empty.
Source Files