git-lfs

command module
v0.5.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 29, 2015 License: MIT Imports: 2 Imported by: 0

README

Git Large File Storage Build Status

Git LFS is a command line extension and specification for managing large files with Git. The client is written in Go, with pre-compiled binaries available for Mac, Windows, Linux, and FreeBSD. Check out the Git LFS website for a high level overview of features.

See CONTRIBUTING.md for info on working on Git LFS and sending patches. Related projects are listed on the Implementations wiki page.

Getting Started

Download the latest client and run the included install script. The installer should run git lfs init for you, which sets up Git's global configuration settings for Git LFS.

Note: Git LFS requires Git v1.8.2 or higher.

Configuration

Git LFS uses .gitattributes files to configure which are managed by Git LFS. Here is a sample one that saves zips and mp3s:

$ cat .gitattributes
*.mp3 filter=lfs -text
*.zip filter=lfs -text

Git LFS can manage .gitattributes for you:

$ git lfs track "*.mp3"
Tracking *.mp3

$ git lfs track "*.zip"
Tracking *.zip

$ git lfs track
Listing tracked paths
    *.mp3 (.gitattributes)
    *.zip (.gitattributes)

$ git lfs untrack "*.zip"
Untracking *.zip

$ git lfs track
Listing tracked paths
    *.mp3 (.gitattributes)
Pushing commits

Once setup, you're ready to push some commits:

$ git add my.zip
$ git commit -m "add zip"

You can confirm that Git LFS is managing your zip file:

$ git lfs ls-files
my.zip

Once you've made your commits, push your files to the Git remote:

$ git push origin master
Sending my.zip
12.58 MB / 12.58 MB  100.00 %
Counting objects: 2, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (5/5), done.
Writing objects: 100% (5/5), 548 bytes | 0 bytes/s, done.
Total 5 (delta 1), reused 0 (delta 0)
To https://github.com/github/git-lfs-test
   67fcf6a..47b2002  master -> master

See the Git LFS overview and man pages.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package git contains various commands that shell out to git Package git contains various commands that shell out to git
Package git contains various commands that shell out to git Package git contains various commands that shell out to git
test
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL