shinmera / legit

CL interface to the GIT binary.

About Legit

This is an interface to the GIT binary to make controlling it from within CL much easier. I've had the need to do this kind of thing a couple of times now, so I might as well encapsulate it into a proper library. I don't know if this is ever going to reach full coverage of all features given GIT's immense size, but I will add features as they are needed. The low-level command API is fully mapped however.

How To

You will need the git binary in your PATH. Once you got that, and have this system loaded via ASDF or Quicklisp, you can access all the git commands through functions.

(legit:with-chdir ("some/git/dir")
  (legit:git-rev-parse "HEAD" :short T))

All commands have been hand-rewritten to work through the uniform and comfortable API we're used to from Lisp. There is an even more convenient (albeit incomplete) interface using repository instances.

(let ((repository (make-instance 'legit:repository :location "some/git/dir")))
  (values (legit:commits repository)
          (legit:current-branch repository)
          (legit:remote-url repository)))

A lot of the information about a repository that you can access will automatically be cached until some destructive operation (like a pull) occurs, so that querying that information does not take so much time each request.

Also See

• Simple-inferiors for running and controlling the git binary.

legit's Issues

Parameters to legit:git-commit

Greetings,
First off, thanks for this great wrapper!

I am able to use git-add, git-pull etc. functions. But I am quite unable to get git-commit working.
Always run into
; Evaluation aborted on #<SB-PCL::NO-APPLICABLE-METHOD-ERROR {1003B81E03}>.

How exactly should I pass the parameters to this function?
e.g. here is one of the things I had tried:
(legit:with-chdir (folder) (legit:commit :message "My Commit Message"))

In slime completion, it looks the same as other functions I am able to use.

My env: Mac OS X High Sierra, SBCL 1.4.10 , Emacs 26
Appreciate your time.

Thanks
pj

Possibly broken repository functions (commit-age, etc.)

This outputs nothing for me:

(let ((repository (make-instance 'legit:repository :location "path/to/some/repo")))
   (legit:commit-message repository "3770dedb7ebf0e96e13bea09d94c377c241af800"))
T

Looking at the definition of commit-message, it seems that revision-range
should be used in place of paths:

(define-repo-function commit-message (repository commit &key)
-  (git-value repository `(message ,commit) (git-log :pretty "%B" :max-count 1 :paths commit)))
+  (git-value repository `(message ,commit) (git-log :pretty "%B" :max-count 1 :revision-range commit)))

Mistake?

when eval (legit:git pull) there is error, cannot support the repository with password

fatal: could not read Password for 'https://[email protected]': No such device or address

Get all the branches & get all the tags

git-branch seems to be a low level function, and when called without arguments it prints the branches exactly as git branch does. Is there some way to get all the branches as a first class data structure? Same question for tags.

`cached` keyword argument is missing for `git diff`

Without it, git diff won't display staged changes.

Git docs links redirecting to NIL

Browsing the docs, I came across links like these:

See https://git-scm.com/docs/git-add

The URL is hyperlinked, but leads to http://shinmera.github.io/legit/NIL