README.org

Magit LFS

Magit LFS

Git LFS for Magit, glorious Git client for Emacs!

Installation

1. In your emacs setting file, initialize melpa package.
2. Follows instruction for your package managing method.
   • For package.el
     1. Install magit and magit-lfs via package-install command.
     2. Write following codes to your emacs setting file. (usually .emacs or .emacs.d/init.el)

        (require 'package)
        
        ;; package repository settings
        
        (package-initialize)
        
        ;; Settings ...
        
        (require 'magit)
        
        ;; Settings ...
        
        (require 'magit-lfs)
                    

   • For use-package.el
     1. Install magit and load it.
     2. Write following codes to your emacs setting file.

        (require 'package)
        (require 'use-package)
        
        ;; Settings ...
        
        (package-initialize)
        
        ;; After load magit
        
        (use-package magit-lfs
             :ensure t
             :pin melpa)
                    

   • For req-package.el
     1. Write following codes to your emacs settings file.

        (require 'package)
        
        ;; Settings ...
        
        (package-initialize)
        
        ;; Settings ...
        
        (require 'req-package)
        
        ;; Settings ...
        
        (req-package magit-lfs
          :loader :elpa
          :pin melpa
          :require (magit))
                    

Magit Binding

• : Initial commands for magit-lfs.
  • f git lfs fetch
  • F git lfs Pull
  • i git lfs install
  • P git lfs push
  • U git lfs update
  • ! git lfs fsck

Breaking changes

The bindings for the initial popup were & and @, but they conflicted with bindings for other magit bindings, so I changed the binding to :

Todo List

• Core functionality [2/3]
  • [X] Make magit popup
  • [ ] Checking git lfs status
  • [X] Connect to git lfs
• Command specific functionality [6/12]
  • [ ] checkout
  • [X] fetch
  • [X] fsck
  • [X] install
  • [ ] logs
  • [ ] ls-files
  • [X] pull
  • [X] push
  • [ ] status
  • [ ] track
  • [ ] untrack
  • [X] update