Skip to content

Commit

Permalink
Update documentation for git-repl
Browse files Browse the repository at this point in the history
  • Loading branch information
wyattscarpenter committed Sep 21, 2024
1 parent 95ccb62 commit f712146
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 65 deletions.
7 changes: 3 additions & 4 deletions Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -382,10 +382,9 @@ the repl.

```bash
$ git repl
git version 2.9.2
git-extras version 3.0.0
type 'ls' to ls files below current directory,
'!command' to execute any command or just 'subcommand' to execute any git subcommand
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
Expand Down
50 changes: 16 additions & 34 deletions man/git-repl.1
Original file line number Diff line number Diff line change
@@ -1,56 +1,42 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-REPL" "1" "October 2017" "" "Git Extras"
.
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GIT\-REPL" "1" "September 2024" "" "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\'\.
.
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
Commands can be prefixed with an exclamation mark (!) to be interpreted as a regular command\.
.
Any arguments to git repl will be taken collectively as the first command to execute in the repl\.
.P
Type \fBexit\fR or \fBquit\fR to end the repl session\.
.
Type \fBexit\fR, \fBquit\fR, or \fBq\fR to end the repl session\. Ctrl\-D an 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\'\.
.
Equivalent of 'git ls\-files'\.
.P
exit|quit
.
exit|quit|q
.P
Ends the repl session\.
.
.SH "EXAMPLES"
.
.nf

$ git repl
git version 2\.9\.2
git\-extras version 3\.0\.0
type \'ls\' to ls files below current directory,
\'!command\' to execute any command or just \'subcommand\' to execute any git subcommand
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
Expand All @@ -67,14 +53,10 @@ 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>
.
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>
51 changes: 28 additions & 23 deletions man/git-repl.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 9 additions & 4 deletions man/git-repl.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,17 @@ git-repl(1) -- git read-eval-print-loop

`git-repl`

`git-repl` [command...]

## DESCRIPTION

Git read-eval-print-loop. Lets you run `git` commands without typing 'git'.

Commands can be prefixed with an exclamation mark (!) to be interpreted as
a regular command.
a regular shell command.

Any arguments to git repl will be taken collectively as the first command
to execute in the repl.

Type `exit`, `quit`, or `q` to end the repl session. Ctrl-D an Ctrl-C
will also work.
Expand All @@ -29,7 +34,7 @@ git-repl(1) -- git read-eval-print-loop

Equivalent of 'git ls-files'.

exit|quit|q
exit\|quit\|q

Ends the repl session.

Expand All @@ -39,7 +44,7 @@ git-repl(1) -- git read-eval-print-loop
$ 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.
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
Expand All @@ -59,7 +64,7 @@ git-repl(1) -- git read-eval-print-loop

## AUTHOR

Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;. 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.

## REPORTING BUGS

Expand Down

0 comments on commit f712146

Please sign in to comment.