Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ailrun/magit-lfs

Git LFS for magit!
https://github.com/ailrun/magit-lfs

emacs lfs magit version-control

Last synced: 4 months ago
JSON representation

Git LFS for magit!

Awesome Lists containing this project

README

        

# Magit LFS

[Git LFS](https://git-lfs.github.com/) for [Magit](https://github.com/magit/magit), glorious Git client for Emacs!

1. [Installation](#org8e78023)
2. [Magit Binding](#orgb5694bc)
1. [Breaking changes](#org82fd3a2)
3. [Todo List](#org34096ab)

## Installation

1. In your emacs setting file, initialize [melpa](https://github.com/melpa/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