git-lfs/docs/man/git-lfs.1.ronn

51 lines
1.7 KiB
Plaintext
Raw Normal View History

git-lfs(1) -- Work with large files in Git repositories
=======================================================
2014-06-02 22:06:48 +00:00
## SYNOPSIS
2015-03-19 19:30:55 +00:00
`git lfs` <command> [<args>]
2014-06-02 22:06:48 +00:00
## DESCRIPTION
2015-04-13 09:16:09 +00:00
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.
2014-06-02 22:10:38 +00:00
## COMMANDS
Like Git, Git LFS commands are separated into high level ("porcelain")
2014-06-02 22:35:56 +00:00
commands and low level ("plumbing") commands.
### High-level commands (porcelain)
2015-03-19 19:30:55 +00:00
* git-lfs-config(1):
Display the Git LFS environment.
2015-03-19 19:30:55 +00:00
* git-lfs-init(1):
Ensure Git LFS is configured properly.
2015-03-19 19:30:55 +00:00
* git-lfs-logs(1):
Show errors from the git-lfs command.
2015-03-22 18:59:56 +00:00
* git-lfs-track(1):
View or add Git LFS paths to Git attributes.
* git-lfs-untrack(1):
Remove Git LFS paths from Git Attributes.
2015-03-19 19:30:55 +00:00
* git-lfs-push(1):
Push queued large files to the Git LFS endpoint.
2014-06-02 22:56:01 +00:00
### Low level commands (plumbing)
2015-03-19 19:30:55 +00:00
* git-lfs-clean(1):
2014-06-02 22:56:01 +00:00
Git clean filter that converts large files to pointers.
2015-03-19 19:30:55 +00:00
* git-lfs-smudge(1):
2014-06-02 22:56:01 +00:00
Git smudge filter that converts pointer in blobs to the actual content.