tj.git-extras/man/git-repl.1
John Bachir 6ed2643252
ability to specify command when hitting enter (#1223)
* ability to specify command when hitting enter

* documentation

* man page

* generate man page and html

* run default command through same logic as other commands

impetuous: persist return val for display in promt if non-zero

also future-proofs for other benefits / DRYness. no need for another eval invocation.

* fix generated manpage
2026-01-20 14:11:45 +08:00

77 lines
2.3 KiB
Groff

.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
.TH "GIT\-REPL" "1" "January 2026" "" "Git Extras"
.SH "NAME"
\fBgit\-repl\fR \- git read\-eval\-print\-loop
.SH "SYNOPSIS"
\fBgit\-repl\fR
.P
\fBgit\-repl\fR [command\|\.\|\.\|\.]
.SH "DESCRIPTION"
Git read\-eval\-print\-loop\. Lets you run \fBgit\fR commands without typing 'git'\.
.P
Commands can be prefixed with an exclamation mark (!) to be interpreted as a regular shell command\.
.P
Any arguments to git repl will be taken collectively as the first command to execute in the repl\.
.P
Type \fBexit\fR, \fBquit\fR, or \fBq\fR to end the repl session\. Ctrl\-D and Ctrl\-C will also work\.
.SH "COMMANDS"
<command>
.P
Interpreted as \fBgit <command>\fR\.
.P
!<command>
.P
Interpreted as \fB<command>\fR (not through \fBgit\fR)\.
.P
ls
.P
Equivalent of 'git ls\-files'\.
.P
exit|quit|q
.P
Ends the repl session\.
.SH "CONFIGURATION"
You can specify a default command to run when hitting enter:
.P
\fBgit config \-\-global git\-extras\.repl\.on\-enter\-command "git status \-sb"\fR
.P
You can configure which character is used at the end of the prompt (default \fB>\fR):
.P
\fBgit config \-\-global git\-extras\.repl\.prompt\-character "±"\fR
.P
You can specify the prefix for the prompt (default \fBgit\fR): \fBgit config \-\-global git\-extras\.repl\.prefix ""\fR
.P
You can have the name of the current git repo shown in the prompt (default \fBfalse\fR):
.P
\fBgit config \-\-global git\-extras\.repl\.show\-project\-name "true"\fR
.SH "EXAMPLES"
.nf
$ git repl
git version 2\.34\.1
git\-extras version 7\.3\.0
Type 'ls' to ls files below current directory; '!command' to execute any command or just 'subcommand' to execute any git subcommand; 'quit', 'exit', 'q', ^D, or ^C to exit the git repl\.
git (master)> ls\-files
History\.md
Makefile
Readme\.md
bin/git\-changelog
bin/git\-count
bin/git\-delete\-branch
bin/git\-delete\-tag
bin/git\-ignore
bin/git\-release
git (master)> !echo Straight from the shell!
Straight from the shell!
git (master)> quit
.fi
.SH "AUTHOR"
Written by Tj Holowaychuk <\fItj@vision\-media\.ca\fR>\. Updated by Wyatt S Carpenter to add display of the previous command's exit status, 'q', and the ability to pass in the initial command as arguments\.
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>