This is the legit Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 06:06:17 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
legitCL interface to the GIT binary.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/legit.git)
zlib
1.0.0
uiop (system).
simple-inferiors (system).
lambda-fiddle (system).
cl-ppcre (system).
documentation-utils (system).
package.lisp (file).
toolkit.lisp (file).
process.lisp (file).
low-level.lisp (file).
repository.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
legit/legit.asdlegit/package.lisplegit/toolkit.lisplegit/process.lisplegit/low-level.lisplegit/repository.lisplegit/documentation.lisplegit/toolkit.lisppackage.lisp (file).
legit (system).
relative-dir (function).
%opt (macro).
*unix-epoch-difference* (special variable).
argetypecase (macro).
define-argparser (macro).
define-git-wrapper (macro).
ensure-list (function).
front-arg-p (function).
minimal-shell-namestring (function).
p-symb (function).
parse-kargdef (function).
parse-oargdef (function).
parse-rargdef (function).
purify-args (function).
shellify (function).
universal-to-unix-time (function).
unix-to-universal-time (function).
legit/process.lisptoolkit.lisp (file).
legit (system).
*git-errors* (special variable).
*git-input* (special variable).
*git-output* (special variable).
git-error (condition).
run-git (function).
%resolve-stream (function).
coerce-to-cmdarg (function).
flatten (function).
legit/low-level.lispprocess.lisp (file).
legit (system).
git-add (function).
git-am (function).
git-apply (function).
git-archive (function).
git-bisect (function).
git-blame (function).
git-branch (function).
git-bundle (function).
git-cat-file (function).
git-checkout (function).
git-cherry-pick (function).
git-clean (function).
git-clone (function).
git-commit (function).
git-commit-tree (function).
git-config (function).
git-count-objects (function).
git-daemon (function).
git-describe (function).
git-diff (function).
git-diff-index (function).
git-fast-import (function).
git-fetch (function).
git-filter-branch (function).
git-for-each-ref (function).
git-format-patch (function).
git-fsck (function).
git-gc (function).
git-grep (function).
git-hash-object (function).
git-help (function).
git-init (function).
git-instaweb (function).
git-log (function).
git-ls-files (function).
git-merge (function).
git-merge-base (function).
git-mergetool (function).
git-mv (function).
git-pull (function).
git-push (function).
git-read-tree (function).
git-rebase (function).
git-reflog (function).
git-remote (function).
git-request-pull (function).
git-reset (function).
git-rev-list (function).
git-rev-parse (function).
git-revert (function).
git-rm (function).
git-send-email (function).
git-shortlog (function).
git-show (function).
git-show-ref (function).
git-stash (function).
git-status (function).
git-submodule (function).
git-svn (function).
git-symbolic-ref (function).
git-tag (function).
git-update-index (function).
git-update-ref (function).
git-update-server-info (function).
git-verify-pack (function).
git-write-tree (function).
legit/repository.lisplow-level.lisp (file).
legit (system).
add (generic function).
bare-p (generic function).
branches (generic function).
checkout (generic function).
clean (generic function).
clear-cache (generic function).
clone (generic function).
commit (generic function).
commit-age (generic function).
commit-author (generic function).
commit-message (generic function).
commits (generic function).
current-age (generic function).
current-branch (generic function).
current-commit (generic function).
current-message (generic function).
default-remote (generic function).
do-submodules (macro).
fetch (generic function).
git-location-p (function).
git-value (macro).
init (generic function).
(setf location) (writer method).
location (reader method).
map-submodules (generic function).
print-object (method).
pull (generic function).
push (generic function).
remote-url (generic function).
remotes (generic function).
(setf remotes) (function).
repository (class).
reset (generic function).
submodules (generic function).
tags (generic function).
branch-remote (generic function).
cache (reader method).
(setf cache) (writer method).
define-repo-function (macro).
handle-init (function).
ref-names-endings (function).
set-remotes (generic function).
legit/documentation.lisprepository.lisp (file).
legit (system).
Packages are listed by definition order.
legitorg.shirakumo.legit
common-lisp.
simple-inferiors.
*git-errors* (special variable).
*git-input* (special variable).
*git-output* (special variable).
add (generic function).
bare-p (generic function).
branches (generic function).
checkout (generic function).
clean (generic function).
clear-cache (generic function).
clone (generic function).
commit (generic function).
commit-age (generic function).
commit-author (generic function).
commit-message (generic function).
commits (generic function).
current-age (generic function).
current-branch (generic function).
current-commit (generic function).
current-message (generic function).
default-remote (generic function).
do-submodules (macro).
fetch (generic function).
git-add (function).
git-am (function).
git-apply (function).
git-archive (function).
git-bisect (function).
git-blame (function).
git-branch (function).
git-bundle (function).
git-cat-file (function).
git-checkout (function).
git-cherry-pick (function).
git-clean (function).
git-clone (function).
git-commit (function).
git-commit-tree (function).
git-config (function).
git-count-objects (function).
git-daemon (function).
git-describe (function).
git-diff (function).
git-diff-index (function).
git-error (condition).
git-fast-import (function).
git-fetch (function).
git-filter-branch (function).
git-for-each-ref (function).
git-format-patch (function).
git-fsck (function).
git-gc (function).
git-grep (function).
git-hash-object (function).
git-help (function).
git-init (function).
git-instaweb (function).
git-location-p (function).
git-log (function).
git-ls-files (function).
git-merge (function).
git-merge-base (function).
git-mergetool (function).
git-mv (function).
git-pull (function).
git-push (function).
git-read-tree (function).
git-rebase (function).
git-reflog (function).
git-remote (function).
git-request-pull (function).
git-reset (function).
git-rev-list (function).
git-rev-parse (function).
git-revert (function).
git-rm (function).
git-send-email (function).
git-shortlog (function).
git-show (function).
git-show-ref (function).
git-stash (function).
git-status (function).
git-submodule (function).
git-svn (function).
git-symbolic-ref (function).
git-tag (function).
git-update-index (function).
git-update-ref (function).
git-update-server-info (function).
git-value (macro).
git-verify-pack (function).
git-write-tree (function).
init (generic function).
map-submodules (generic function).
pull (generic function).
push (generic function).
relative-dir (function).
remote-url (generic function).
remotes (generic function).
(setf remotes) (function).
repository (class).
reset (generic function).
run-git (function).
submodules (generic function).
tags (generic function).
%opt (macro).
%resolve-stream (function).
*unix-epoch-difference* (special variable).
argetypecase (macro).
branch-remote (generic function).
cache (generic reader).
(setf cache) (generic writer).
coerce-to-cmdarg (function).
define-argparser (macro).
define-git-wrapper (macro).
define-repo-function (macro).
ensure-list (function).
flatten (function).
front-arg-p (function).
handle-init (function).
minimal-shell-namestring (function).
p-symb (function).
parse-kargdef (function).
parse-oargdef (function).
parse-rargdef (function).
purify-args (function).
ref-names-endings (function).
set-remotes (generic function).
shellify (function).
universal-to-unix-time (function).
unix-to-universal-time (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The stream to which the error output of the git process is sent.
Defaults to T, but may be automatically bound by some functions in order to process the output.
The stream from which the standard input of the git process is taken.
Defaults to NIL.
The stream to which the standard output of the git process is sent.
Defaults to T, but may be automatically bound by some functions in order to process the output.
Iterates over all submodules of REPOSITORY.
See MAP-SUBMODULES
See REPOSITORY
Shorthand macro to handle caching of the value from the git process under NAME.
git add
See https://git-scm.com/docs/git-add
git am
See https://git-scm.com/docs/git-am
git apply
See https://git-scm.com/docs/git-apply
git archive
See https://git-scm.com/docs/git-archive
git bisect
See https://git-scm.com/docs/git-bisect
git blame
See https://git-scm.com/docs/git-blame
git branch
See https://git-scm.com/docs/git-branch
git bundle
See https://git-scm.com/docs/git-bundle
git cat-file
See https://git-scm.com/docs/git-cat-file
git checkout
See https://git-scm.com/docs/git-checkout
git cherry-pick
See https://git-scm.com/docs/git-cherry-pick
git clean
See https://git-scm.com/docs/git-clean
git clone
See https://git-scm.com/docs/git-clone
git commit
See https://git-scm.com/docs/git-commit
git commit-tree
See https://git-scm.com/docs/git-commit-tree
git config
See https://git-scm.com/docs/git-config
git count-objects
See https://git-scm.com/docs/git-count-objects
git daemon
See https://git-scm.com/docs/git-daemon
git describe
See https://git-scm.com/docs/git-describe
git diff
See https://git-scm.com/docs/git-diff
git diff-index
See https://git-scm.com/docs/git-diff-index
git fast-import
See https://git-scm.com/docs/git-fast-import
git fetch
See https://git-scm.com/docs/git-fetch
git filter-branch
See https://git-scm.com/docs/git-filter-branch
git for-each-ref
See https://git-scm.com/docs/git-for-each-ref
git format-patch
See https://git-scm.com/docs/git-format-patch
git fsck
See https://git-scm.com/docs/git-fsck
git gc
See https://git-scm.com/docs/git-gc
git grep
See https://git-scm.com/docs/git-grep
git hash-object
See https://git-scm.com/docs/git-hash-object
git help
See https://git-scm.com/docs/git-help
git init
See https://git-scm.com/docs/git-init
git instaweb
See https://git-scm.com/docs/git-instaweb
Returns T if the given location/path is a, or within a git repository.
git log
See https://git-scm.com/docs/git-log
git ls-files
See https://git-scm.com/docs/git-ls-files
git merge
See https://git-scm.com/docs/git-merge
git merge-base
See https://git-scm.com/docs/git-merge-base
git mergetool
See https://git-scm.com/docs/git-mergetool
git mv
See https://git-scm.com/docs/git-mv
git pull
See https://git-scm.com/docs/git-pull
git push
See https://git-scm.com/docs/git-push
git read-tree
See https://git-scm.com/docs/git-read-tree
git rebase
See https://git-scm.com/docs/git-rebase
git reflog
See https://git-scm.com/docs/git-reflog
git remote
See https://git-scm.com/docs/git-remote
git request-pull
See https://git-scm.com/docs/git-request-pull
git reset
See https://git-scm.com/docs/git-reset
git rev-list
See https://git-scm.com/docs/git-rev-list
git rev-parse
See https://git-scm.com/docs/git-rev-parse
git revert
See https://git-scm.com/docs/git-revert
git rm
See https://git-scm.com/docs/git-rm
git send-email
See https://git-scm.com/docs/git-send-email
git shortlog
See https://git-scm.com/docs/git-shortlog
git show
See https://git-scm.com/docs/git-show
git show-ref
See https://git-scm.com/docs/git-show-ref
git stash
See https://git-scm.com/docs/git-stash
git status
See https://git-scm.com/docs/git-status
git submodule
See https://git-scm.com/docs/git-submodule
git svn
See https://git-scm.com/docs/git-svn
git symbolic-ref
See https://git-scm.com/docs/git-symbolic-ref
git tag
See https://git-scm.com/docs/git-tag
git update-index
See https://git-scm.com/docs/git-update-index
git update-ref
See https://git-scm.com/docs/git-update-ref
git update-server-info
See https://git-scm.com/docs/git-update-server-info
git verify-pack
See https://git-scm.com/docs/git-verify-pack
git write-tree
See https://git-scm.com/docs/git-write-tree
Get a directory pathname that is SUBDIRS beneath RELATIVE.
Launches a new git process with the given CMDARGS.
See LEGIT:RUN
See *GIT-OUTPUT*
See *GIT-ERRORS*
See *GIT-INPUT*
repository) files &key) ¶pathname) files &rest rest0) ¶string) files &rest rest0) ¶Returns T if the REPOSITORY is bare.
See GIT-REV-PARSE
See REPOSITORY
repository) &key) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Returns a list of branch names for REPOSITORY.
See GIT-BRANCH
See REPOSITORY
repository) &key) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Checks out a specific THING in the repository.
This clears the cache.
See GIT-CHECKOUT
See REPOSITORY
See CLEAR-CACHE
repository) thing &key) ¶pathname) thing &rest rest0) ¶string) thing &rest rest0) ¶Cleans the repository out.
Default extra keyword arguments are DIRECTORIES, FORCE, IGNORED.
See GIT-CLEAN
See REPOSITORY
repository) &key directories force ignored) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Clears the internal cache on the git repository.
Calling this causes subsequent queries against the repository to actually launch a subprocess. This should be called whenever the repository on the file system may have been modified in any way.
See REPOSITORY
repository) &key key) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Clone a repository from FROM to TO.
Default extra keyword arguments are BRANCH and BARE.
See GIT-CLONE
repository) to &rest args &key) ¶pathname) to &rest args &key) ¶string) (to repository) &rest args &key) ¶string) (to pathname) &rest args &key) ¶string) (to string) &key branch bare single-branch) ¶repository) message &key amend) ¶pathname) message &rest rest0) ¶string) message &rest rest0) ¶Returns a universal-time timestamp of when the given commit was made.
See GIT-LOG
See REPOSITORY
repository) commit &key) ¶pathname) commit &rest rest0) ¶string) commit &rest rest0) ¶repository) commit &key) ¶pathname) commit &rest rest0) ¶string) commit &rest rest0) ¶repository) commit &key) ¶pathname) commit &rest rest0) ¶string) commit &rest rest0) ¶Returns the full list of commit hashes on the repository.
See GIT-REV-LIST
See REPOSITORY
repository) &key) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Returns the latest commit’s age on the current branch of the REPOSITORY as a universal-time timestamp.
See GIT-LOG
See REPOSITORY
repository) &key) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Returns the currently checked out branch of the REPOSITORY.
See GIT-REV-PARSE
See REPOSITORY
repository) &key) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Returns the latest commit hash on the current branch of the REPOSITORY.
See GIT-REV-PARSE
See REPOSITORY
repository) &key short) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Returns the latest commit’s message on the current branch of the REPOSITORY.
See GIT-LOG
See REPOSITORY
repository) &key) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Returns a suitable default remote name.
Will get the branch’s configured remote, if any, or fall back to the
first available remote.
See REPOSITORY
repository) &key branch) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Fetch the latest commits from upstream.
This clears the cache.
See GIT-FETCH
See REPOSITORY
See CLEAR-CACHE
repository) &key remote branch) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Initialises the given repository.
REPOSITORY can be a pathname or repository. Optionally supplied keyword arguments are
by default
IF-DOES-NOT-EXIST ::= :error — Signal an error if it does not exist.
| :ignore — Just return a repository instance.
| :create | :init — Initialise a new, empty repository.
| :clone — Clone a new repository from a remote.
REMOTE — An optional remote path used to clone the repository, if
IF-DOES-NOT-EXIST is :CLONE
BRANCH — The branch to use if IF-DOES-NOT-EXIST is :CLONE, :CREATE, or
:INIT.
BARE — Whether the repository should be bare if IF-DOES-NOT-EXIST is
:CLONE, :CREATE, or :INIT.
See REPOSITORY
See GIT-INIT
See GIT-CHECKOUT
See GIT-CLONE
string) &rest args) ¶pathname) &key if-does-not-exist remote branch bare) ¶repository) &key if-does-not-exist remote branch bare) ¶Maps FUNCTION over all submodules of REPOSITORY.
See SUBDMODULES
See REPOSITORY
repository) function &rest args &key) ¶pathname) function &rest rest0) ¶string) function &rest rest0) ¶Pull and merge the latest commits from upstream.
This clears the cache.
See GIT-PULL
See REPOSITORY
See CLEAR-CACHE
repository) &key refspecs remote) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶repository) &key refspecs remote) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Returns the address of a remote (default "origin") on the REPOSITORY.
Accepts a default keyword argument REMOTE.
See GIT-CONFIG
See REPOSITORY
repository) &key remote) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Returns an alist of all remotes on the REPOSITORY. The CAR is the name, the CDR the address.
This function is SETF-able, meaning you can PUSH new remotes to it or remove
remotes by SETF&REMOVE. It will also gracefully change the address of a remote
if it is changed in the setted list.
Setting REMOTES clears the cache.
See GIT-REMOTE
See REPOSITORY
See CLEAR-CACHE
repository) &key) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Resets changes in the repository.
Default extra keyword arguments are TO, HARD, MIXED, SOFT.
This clears the cache.
See GIT-RESET
See REPOSITORY
See CLEAR-CACHE
repository) &key to hard mixed soft) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Returns a list of REPOSITORY instances that represent the submodules of REPOSITORY.
See GIT-SUBMODULE
See REPOSITORY
repository) &key recursive only-existing) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶Returns a list of tag names for REPOSITORY.
See GIT-TAG
See REPOSITORY
repository) &key) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶repository)) ¶automatically generated writer method
simple-inferiors.
repository)) ¶automatically generated reader method
simple-inferiors.
repository) stream) ¶A class to represent a git repository with.
This is a LOCATION.
See LOCATION
See INIT
add.
bare-p.
branch-remote.
branches.
(setf cache).
cache.
checkout.
clean.
clear-cache.
clone.
clone.
commit.
commit-age.
commit-author.
commit-message.
commits.
current-age.
current-branch.
current-commit.
current-message.
default-remote.
fetch.
init.
(setf location).
location.
map-submodules.
print-object.
pull.
push.
remote-url.
remotes.
reset.
set-remotes.
submodules.
tags.
| Initarg | Value |
|---|---|
:location | nil |
simple-inferiors.
:location
(make-hash-table :test (quote equal))
repository) &key branch) ¶pathname) &rest rest0) ¶string) &rest rest0) ¶repository)) ¶automatically generated reader method
repository)) ¶automatically generated writer method
repository) (new-remotes list) &key) ¶pathname) new-remotes &rest rest0) ¶string) new-remotes &rest rest0) ¶| Jump to: | %
(
A B C D E F G H I L M P R S T U |
|---|
| Jump to: | %
(
A B C D E F G H I L M P R S T U |
|---|
| Jump to: | *
C E L S |
|---|
| Jump to: | *
C E L S |
|---|
| Jump to: | C D F G L P R S T |
|---|
| Jump to: | C D F G L P R S T |
|---|